# Streamlit Pocketbase Connector
This repository contains a [Streamlit](https://streamlit.io) app that connects to a [Pocketbase](https://pocketbase.io)
database.
The goal of this app is to provide a simple example of how to connect to a Pocketbase database using
the [Pocketbase Python Client](https://github.com/vaphes/pocketbase) and Streamlit's
new [Connection API](https://docs.streamlit.io/library/api-reference/connections/st.connection).
## How to run this app
> **Note:** You need poetry installed to run this app. If you don't have it, you can follow the
> instructions [here](https://python-poetry.org/docs/#installation).
1. Clone this repo.
2. Create `.streamlit/secrets.toml` and add your Pocketbase Endpoint. It should look like this:
```toml
pb_url = "http://127.0.0.1:8090"
```
3. Run `poetry install` in the root directory of this repo.
4. Download the Pocketbase Executable from [here](https://github.com/pocketbase/pocketbase/releases) and run it.
5. Run `poetry run streamlit run app.py` in the root directory of this repo.
6. Enjoy!
## Demo
You can see a demo of this app [here](https://st-pocketbase-connection.streamlit.app/).
[streamlit-app-2023-08-02-16-08-05.webm](https://github.com/Ashwin-op/st-pocketbase-connection/assets/60032753/ee89b16a-2c11-43d1-a92f-67d5ecfc2fc7)
Raw data
{
"_id": null,
"home_page": "https://github.com/Ashwin-op/st-pocketbase-connection",
"name": "st-pocketbase-connection",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Ashwin",
"author_email": "bsashwin9@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4c/b7/c595a2ca9f2cd753ff98581826023d3651fc55c97e434cf3dda5da850e58/st_pocketbase_connection-0.3.0.tar.gz",
"platform": null,
"description": "# Streamlit Pocketbase Connector\n\nThis repository contains a [Streamlit](https://streamlit.io) app that connects to a [Pocketbase](https://pocketbase.io)\ndatabase.\n\nThe goal of this app is to provide a simple example of how to connect to a Pocketbase database using\nthe [Pocketbase Python Client](https://github.com/vaphes/pocketbase) and Streamlit's\nnew [Connection API](https://docs.streamlit.io/library/api-reference/connections/st.connection).\n\n## How to run this app\n\n> **Note:** You need poetry installed to run this app. If you don't have it, you can follow the\n> instructions [here](https://python-poetry.org/docs/#installation).\n\n1. Clone this repo.\n2. Create `.streamlit/secrets.toml` and add your Pocketbase Endpoint. It should look like this:\n\n```toml\npb_url = \"http://127.0.0.1:8090\"\n```\n\n3. Run `poetry install` in the root directory of this repo.\n4. Download the Pocketbase Executable from [here](https://github.com/pocketbase/pocketbase/releases) and run it.\n5. Run `poetry run streamlit run app.py` in the root directory of this repo.\n6. Enjoy!\n\n## Demo\n\nYou can see a demo of this app [here](https://st-pocketbase-connection.streamlit.app/).\n\n[streamlit-app-2023-08-02-16-08-05.webm](https://github.com/Ashwin-op/st-pocketbase-connection/assets/60032753/ee89b16a-2c11-43d1-a92f-67d5ecfc2fc7)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Streamlit extension to access pocketbase",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/Ashwin-op/st-pocketbase-connection"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe551ee17f6fca66c134f751ba101632448bb01455677f9c97cf8d392d17f8be",
"md5": "21ade8075036309620392b8ba4350d93",
"sha256": "de19911429628ac889f97589b0c0aaefb29504b4db00905a4f00dd700cda7e31"
},
"downloads": -1,
"filename": "st_pocketbase_connection-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21ade8075036309620392b8ba4350d93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 4089,
"upload_time": "2023-12-23T20:39:49",
"upload_time_iso_8601": "2023-12-23T20:39:49.693720Z",
"url": "https://files.pythonhosted.org/packages/fe/55/1ee17f6fca66c134f751ba101632448bb01455677f9c97cf8d392d17f8be/st_pocketbase_connection-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cb7c595a2ca9f2cd753ff98581826023d3651fc55c97e434cf3dda5da850e58",
"md5": "bedff89c41f89b230f87b6de7f85c608",
"sha256": "1c93354dc0741ac1080bade94c9c03b3823b4cf399a8617d7f5d6293cc21e6a9"
},
"downloads": -1,
"filename": "st_pocketbase_connection-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "bedff89c41f89b230f87b6de7f85c608",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 3521,
"upload_time": "2023-12-23T20:39:51",
"upload_time_iso_8601": "2023-12-23T20:39:51.112306Z",
"url": "https://files.pythonhosted.org/packages/4c/b7/c595a2ca9f2cd753ff98581826023d3651fc55c97e434cf3dda5da850e58/st_pocketbase_connection-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-23 20:39:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ashwin-op",
"github_project": "st-pocketbase-connection",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "st-pocketbase-connection"
}
JSON
