Added markdown tutorial for couchbase_streamlit_connector #47
Conversation
|
@VirajAgarwal1 Do you need to publish this as a tutorial? I would publish the other demo as the tutorial while this is lightweight documentation. We could even host it on streamlit & link it in the docs. |
I second this |
|
@VirajAgarwal1 Let us switch the tutorial to the visualization one |
|
I have added the links to the live demos of the both the CRUD tutorial and the visualisations demo in the readme. I am not sure how to add visualisations demo over here as that is a python file. |
|
The pypi link for the project is here. This is where the visualisation demo is getting the package from. |
| - Python 3.10 or higher installed. | ||
| - Ensure that the Python version is [compatible](https://docs.couchbase.com/python-sdk/current/project-docs/compatibility.html#python-version-compat) with the Couchbase SDK. | ||
| - Couchbase Capella account ([Docs](https://docs.couchbase.com/cloud/get-started/intro.html)) | ||
| - An operational cluster created in a project |
There was a problem hiding this comment.
combine above point and this into one
| - Ensure that the Python version is [compatible](https://docs.couchbase.com/python-sdk/current/project-docs/compatibility.html#python-version-compat) with the Couchbase SDK. | ||
| - Couchbase Capella account ([Docs](https://docs.couchbase.com/cloud/get-started/intro.html)) | ||
| - 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)) |
There was a problem hiding this comment.
Also 1st point is only system requirement and rest are prerequisites.
| To install the required dependencies, run: | ||
| ```sh | ||
| git clone https://github.com/Couchbase-Ecosystem/couchbase_streamlit_connector.git | ||
| pip install ./couchbase_streamlit_connector/ |
There was a problem hiding this comment.
provide pip install from pip mangager
Regarding this should I add a new sub heading? |
Added readme.md of couchbase_streamlit_connector to the
tutorial/markdown/python/streamlit/README.mdwith slight modifications.