Skip to content

updated pypi account #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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))
Expand All @@ -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:
Expand Down Expand Up @@ -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.
Expand All @@ -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:

Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
]
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/couchbase_streamlit_connector/__about__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2025-present Viraj Agarwal <virajagarwal15@gmail.com>
#
# SPDX-License-Identifier: MIT
__version__ = "0.2.2"
__version__ = "0.2.3"