| Name | st-mongo-connection JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | Streamlit MongoDB Connector: An efficient connector for interfacing MongoDB with Streamlit apps |
| upload_time | 2023-12-11 13:48:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Moris Doratiotto Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
database
mongo
streamlit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://mongo-connector.streamlit.app)
[](https://pypi.org/project/st-mongo-connection/)
[](https://github.com/psf/black)
# Streamlit MongoDB Connector
This repository contains the source code for a MongoDB connector developed for the [Streamlit Connections Hackathon](https://discuss.streamlit.io/t/connections-hackathon).
The goal of this project is to showcase how to leverage the power of Streamlit's new `st.connection` feature to connect Streamlit applications with MongoDB databases, and use this connection in practical applications.
[<img src="src/media/app.png" >](https://mongo-connector.streamlit.app/)
## Installation & Usage
The package can be installed via [PyPi](https://pypi.org/project/st-mongo-connection/).
```bash
pip3 install st_mongo_connection
```
and the following is a simple example to use it
```python
import streamlit as st
from st_mongo_connection import MongoDBConnection
connection = st.connection("mongodb", type=MongoDBConnection)
st.help(connection)
```
If you want a real example and a detailed implemetation check out the [streamlit app](https://mongo-connector.streamlit.app).
## Overview
The application is divided into three main sections:
1. **Connection Demonstration**: Shows how the connection to MongoDB has been implemented, demonstrating how data can be retrieved and manipulated.
2. **MongoDB Configuration**: Demonstrates how to configure the MongoDB connection, explaining how to set it up via the `secrets.toml` file or directly through the `st.connection` call.
3. **StreamY**: A prototype for a simple text-based social network, where users can post texts on a wall. This showcases the MongoDB connection's use in a practical application, as it's used to store and retrieve posts.
## About me
Hello! I'm Moris, a Computer Science Master's graduate with extensive experience in Streamlit and MongoDB. I've developed the [MagicLit](https://magiclit.streamlit.app) framework to serve as the base for my company's management app.
I participated in this hackathon to create an optimal component for connecting MongoDB to Streamlit. I hope this project will contribute to the Streamlit community and assist other developers.
Raw data
{
"_id": null,
"home_page": "",
"name": "st-mongo-connection",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "database,mongo,streamlit",
"author": "",
"author_email": "Moris Doratiotto <me@moris.dev>",
"download_url": "https://files.pythonhosted.org/packages/69/80/1ec36fed508bae0fee65b2729154c1aad8298456ac1cd1232db8928f75fc/st_mongo_connection-1.0.2.tar.gz",
"platform": null,
"description": "[](https://mongo-connector.streamlit.app)\n[](https://pypi.org/project/st-mongo-connection/)\n[](https://github.com/psf/black)\n\n# Streamlit MongoDB Connector\n\nThis repository contains the source code for a MongoDB connector developed for the [Streamlit Connections Hackathon](https://discuss.streamlit.io/t/connections-hackathon). \nThe goal of this project is to showcase how to leverage the power of Streamlit's new `st.connection` feature to connect Streamlit applications with MongoDB databases, and use this connection in practical applications.\n\n[<img src=\"src/media/app.png\" >](https://mongo-connector.streamlit.app/)\n\n## Installation & Usage\n\nThe package can be installed via [PyPi](https://pypi.org/project/st-mongo-connection/).\n```bash\npip3 install st_mongo_connection\n```\nand the following is a simple example to use it\n```python\nimport streamlit as st\nfrom st_mongo_connection import MongoDBConnection\n\nconnection = st.connection(\"mongodb\", type=MongoDBConnection)\nst.help(connection)\n```\nIf you want a real example and a detailed implemetation check out the [streamlit app](https://mongo-connector.streamlit.app).\n\n## Overview\n\nThe application is divided into three main sections:\n\n1. **Connection Demonstration**: Shows how the connection to MongoDB has been implemented, demonstrating how data can be retrieved and manipulated.\n\n2. **MongoDB Configuration**: Demonstrates how to configure the MongoDB connection, explaining how to set it up via the `secrets.toml` file or directly through the `st.connection` call.\n\n3. **StreamY**: A prototype for a simple text-based social network, where users can post texts on a wall. This showcases the MongoDB connection's use in a practical application, as it's used to store and retrieve posts.\n\n\n## About me\nHello! I'm Moris, a Computer Science Master's graduate with extensive experience in Streamlit and MongoDB. I've developed the [MagicLit](https://magiclit.streamlit.app) framework to serve as the base for my company's management app. \nI participated in this hackathon to create an optimal component for connecting MongoDB to Streamlit. I hope this project will contribute to the Streamlit community and assist other developers.",
"bugtrack_url": null,
"license": " MIT License Copyright (c) 2024 Moris Doratiotto Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Streamlit MongoDB Connector: An efficient connector for interfacing MongoDB with Streamlit apps",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/Mortafix/streamlit-mongo",
"Issues": "https://github.com/Mortafix/streamlit-mongo/issues"
},
"split_keywords": [
"database",
"mongo",
"streamlit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d59b270cf3d75f08232860de14d1b0caa2c62df39cbc612a1f7f223a2754037",
"md5": "d4473a4e14ec362506de989ce4c86289",
"sha256": "eba94910cdf0bea8b0ef44449a6ae1d96b0f028039273b6fc6958654e4c4c788"
},
"downloads": -1,
"filename": "st_mongo_connection-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4473a4e14ec362506de989ce4c86289",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5460,
"upload_time": "2023-12-11T13:48:09",
"upload_time_iso_8601": "2023-12-11T13:48:09.162916Z",
"url": "https://files.pythonhosted.org/packages/9d/59/b270cf3d75f08232860de14d1b0caa2c62df39cbc612a1f7f223a2754037/st_mongo_connection-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69801ec36fed508bae0fee65b2729154c1aad8298456ac1cd1232db8928f75fc",
"md5": "51cdc0f1a78c10e91f91735db8316e60",
"sha256": "f49b41ef9f12af638daa9a5df57cacd3729275576d1a6448551ba2809ce6819a"
},
"downloads": -1,
"filename": "st_mongo_connection-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "51cdc0f1a78c10e91f91735db8316e60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4806,
"upload_time": "2023-12-11T13:48:10",
"upload_time_iso_8601": "2023-12-11T13:48:10.353863Z",
"url": "https://files.pythonhosted.org/packages/69/80/1ec36fed508bae0fee65b2729154c1aad8298456ac1cd1232db8928f75fc/st_mongo_connection-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-11 13:48:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mortafix",
"github_project": "streamlit-mongo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "st-mongo-connection"
}
