From 15ccbbe6e2ce54d8102069d7d556b8a4662a2b44 Mon Sep 17 00:00:00 2001 From: Viraj Agarwal Date: Mon, 24 Feb 2025 14:59:38 +0530 Subject: [PATCH 1/5] changed underscores in name to dashes --- pyproject.toml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index a9c9783..12bc900 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,13 +3,13 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "couchbase_streamlit_connector" +name = "couchbase-streamlit-connector" dynamic = ["version"] description = 'Connector for Couchbase on Streamlit' readme = "README.md" requires-python = ">=3.10" license = { file = "LICENSE" } -keywords = ["couchbase", "streamlit", "connector", "couchbase-connector", "streamlit-connector", "couchbase_streamlit_connector"] +keywords = ["couchbase", "streamlit", "connector", "couchbase-connector", "streamlit-connector", "couchbase-streamlit-connector"] authors = [ { name = "Viraj Agarwal", email = "virajagarwal15@gmail.com" }, ] @@ -29,9 +29,9 @@ dependencies = [ ] [project.urls] -Documentation = "https://github.com/VirajAgarwal1/couchbase_streamlit_connector#readme" -Issues = "https://github.com/VirajAgarwal1/couchbase_streamlit_connector/issues" -Source = "https://github.com/VirajAgarwal1/couchbase_streamlit_connector" +Documentation = "https://github.com/Couchbase-Ecosystem/couchbase-streamlit-connector#readme" +Issues = "https://github.com/Couchbase-Ecosystem/couchbase-streamlit-connector/issues" +Source = "https://github.com/Couchbase-Ecosystem/couchbase-streamlit-connector" [tool.hatch.version] path = "src/couchbase_streamlit_connector/__about__.py" From a3e0dde8fef0393a71634089bf7a68a084ef997f Mon Sep 17 00:00:00 2001 From: VirajAgarwal-couchbase Date: Tue, 25 Feb 2025 10:05:37 +0530 Subject: [PATCH 2/5] updated pypi --- src/couchbase_streamlit_connector/__about__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/couchbase_streamlit_connector/__about__.py b/src/couchbase_streamlit_connector/__about__.py index b3729f7..23678b1 100644 --- a/src/couchbase_streamlit_connector/__about__.py +++ b/src/couchbase_streamlit_connector/__about__.py @@ -1,4 +1,4 @@ # SPDX-FileCopyrightText: 2025-present Viraj Agarwal # # SPDX-License-Identifier: MIT -__version__ = "0.2.2" +__version__ = "0.2.3" From 5591b758c9b16ee4806dc55dd887b4365b2a8778 Mon Sep 17 00:00:00 2001 From: VirajAgarwal-couchbase Date: Tue, 25 Feb 2025 10:08:31 +0530 Subject: [PATCH 3/5] removed numbered headings from readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1695d70..8ccbb3d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Couchbase Connector for Streamlit -## 1. Introduction +## Introduction This project provides a seamless integration between Streamlit and Couchbase, allowing developers to interact with Couchbase databases effortlessly. It enables users to fetch, insert, update, and delete data within Streamlit applications without needing to switch between different SDKs, enhancing the overall development experience. For a working demo please checkout `src/Demo.py` file. You can run it by the command @@ -13,7 +13,7 @@ streamlit run src/Demo.py ``` Or access the hosted version: [Demo App](https://couchbase-connector-demo-app.streamlit.app/) -## 2. Prerequisites +## Prerequisites ### System Requirements - Ensure you have **Python 3.10 or higher** (check [compatibility](https://docs.couchbase.com/python-sdk/current/project-docs/compatibility.html#python-version-compat) with the Couchbase SDK), a **Couchbase Capella account** ([Docs](https://docs.couchbase.com/cloud/get-started/intro.html)), and an **operational cluster** created in a project. - Configured cluster access permissions and allowed IP addresses ([Docs](https://docs.couchbase.com/cloud/get-started/connect.html#prerequisites)) @@ -25,7 +25,7 @@ To install the required dependencies, run: pip install couchbase-streamlit-connector ``` -## 3. Usage Guide +## Usage Guide ### Initializing the Connector You can set up the Couchbase connection using either of the following methods: @@ -107,7 +107,7 @@ result = connection.query("SELECT * FROM `travel-sample`.`inventory`.`airline` L st.write(result) ``` -## 4. Understanding the Code +## Understanding the Code The CouchbaseConnector class is responsible for managing the connection and interaction with Couchbase within a Streamlit app. Below is a high-level breakdown: - _connect(): Establishes a connection to the Couchbase cluster using credentials from either secrets or kwargs. It initializes the cluster, bucket, scope, and collection. @@ -119,7 +119,7 @@ The CouchbaseConnector class is responsible for managing the connection and inte - remove_document(): Deletes a document from the Couchbase collection. - query(): Executes N1QL queries against the Couchbase cluster. -## 5. Appendix +## Appendix Here are some helpful resources for working with Couchbase and Streamlit: From ed9134cae729868b09a533ad85654c5ac6d44e58 Mon Sep 17 00:00:00 2001 From: VirajAgarwal-couchbase Date: Tue, 25 Feb 2025 10:11:19 +0530 Subject: [PATCH 4/5] updated readme --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 8ccbb3d..89a3ffe 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,6 @@ st.write(result) ``` ## Understanding the Code - The CouchbaseConnector class is responsible for managing the connection and interaction with Couchbase within a Streamlit app. Below is a high-level breakdown: - _connect(): Establishes a connection to the Couchbase cluster using credentials from either secrets or kwargs. It initializes the cluster, bucket, scope, and collection. - set_bucket_scope_coll(): Allows users to switch the bucket, scope, or collection dynamically. However, this should only be used when necessary to prevent conflicts. From c2c81665262934f01becf0458f551996ef40ef9d Mon Sep 17 00:00:00 2001 From: VirajAgarwal-couchbase Date: Tue, 25 Feb 2025 10:13:58 +0530 Subject: [PATCH 5/5] updated readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 89a3ffe..8ccbb3d 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ st.write(result) ``` ## Understanding the Code + The CouchbaseConnector class is responsible for managing the connection and interaction with Couchbase within a Streamlit app. Below is a high-level breakdown: - _connect(): Establishes a connection to the Couchbase cluster using credentials from either secrets or kwargs. It initializes the cluster, bucket, scope, and collection. - set_bucket_scope_coll(): Allows users to switch the bucket, scope, or collection dynamically. However, this should only be used when necessary to prevent conflicts.