| Name | streamlit-analytics2 JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | None |
| Summary | Track & visualize user interactions with your streamlit app. |
| upload_time | 2024-04-15 19:14:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2021 Johannes Rieke Copyright (c) 2024 444B 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 |
streamlit
analytics
visualization
streamlit-analytics
streamlit-analytics2
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# streamlit-analytics2 👀
[](https://pypi.org/project/streamlit-analytics2/)
**Enhanced tracking & visualization for your Streamlit apps.**
`streamlit-analytics2` is a fork and extension of the original [streamlit-analytics](https://github.com/jrieke/streamlit-analytics), aimed at improving and securing the analytics functionality within Streamlit applications. With minimal setup, track user interactions and visualize analytics directly in your browser, akin to Google Analytics but tailored for Streamlit.
This fork was initiated due to the inability to collaborate directly on the upstream project, which currently has several unresolved security issues and bugs. Our intention is to maintain a positive relationship with the original project and its creator, focusing on enhancing the tool's reliability and security for the community.
> [!Note]
> This fork is confirmed to fix the deprecation ```st.experimental_get_query_params``` alerts. [Context](https://docs.streamlit.io/library/api-reference/utilities/st.experimental_get_query_params)
> It also resolved 25 security issues that exist in the upstream (2 Critical, 11 High, 10 Moderate, 2 Low)
<sup>This project is in active development. We welcome contributions and address security concerns on a best-effort basis, with details available in our [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md) respectively.</sup>
## Installation
```bash
pip install streamlit-analytics2
```
## Migration from upstream streamlit-analytics
Only two single characters need to be changed and this has been tested and verified to work.
1. Change your requirements.txt or other dependency file to use 'streamlit-analytics**2**'. Just add a '2'
2. Change your code import to use 'streamlit_analytics**2** as streamlit_analytics'. Also, just add a '2'. Seen below.
> [!IMPORTANT]
> This project aims to be backwards compatible with the upstream and migration literally just means adding the number 2 and getting the new package.
> The above steps should be sufficient but if you need more steps, check out our [Migration Guide](https://github.com/444B/streamlit-analytics2/wiki/0.--Migration-Guide-from-streamlit%E2%80%90analytics-to-streamlit%E2%80%90analytics2).
## How to Use
Simple integration with any Streamlit app:
```python
import streamlit as st
import streamlit_analytics2 as streamlit_analytics
with streamlit_analytics.track():
st.write("Hello, World!")
st.button("Click me")
```
All interactions are now tracked, supporting all standard Streamlit widgets.
Another way to get the tracking is to call the streamlit_analytics.track() on your main() function:
```python
import streamlit as st
import streamlit_analytics2 as streamlit_analytics
with streamlit_analytics.track():
main()
def main():
st.write("Hello, World!")
st.button("Click me")
```
Using streamlit_analytics.track() is the recommended method and will become the primary way to initiate streamlit-analytics2 after the [upcoming v.1.0.0](https://github.com/444B/streamlit-analytics2/issues/53) release.
## Moving Forward
- **TODOs and Feature Requests**: We've transitioned our roadmap and feature requests to [GitHub Issues](https://github.com/your-repo/streamlit-analytics2/issues). Feel free to contribute ideas or report bugs!
- **Advanced Configuration**: Detailed guidance on advanced setup (including password protection and database integration) options are available in our [Project Wiki](https://github.com/444B/streamlit-analytics2/wiki).
- **Improved Performance**: We are focused on providing a use of streamlit-analytics2 that doesn't impact the performance of your app.
All suggestions and inputs are welcome on our [forum](https://github.com/444B/streamlit-analytics2/discussions)
## Contributing
Your contributions are welcome! Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to make a difference.
The step by step guide will show you how to set up a dev environment, testing standards and how to make a PR.
## Security
We prioritize the security of our users' data. For reporting security vulnerabilities or for more information, please review our [SECURITY.md](SECURITY.md).
## Acknowledgments
A special thanks to [jrieke](https://github.com/jrieke) and all contributors to the original `streamlit-analytics` project. Your work has inspired continued innovation and community collaboration.
Raw data
{
"_id": null,
"home_page": null,
"name": "streamlit-analytics2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "streamlit, analytics, visualization, streamlit-analytics, streamlit-analytics2",
"author": null,
"author_email": "444B <contact+pypi@444b.me>",
"download_url": "https://files.pythonhosted.org/packages/5e/41/85b6f04daca5e657e2e06fa7f08f17a23ad7a6b106eae4fae41c0b114bdd/streamlit_analytics2-0.7.2.tar.gz",
"platform": null,
"description": "# streamlit-analytics2 \ud83d\udc40\n\n[](https://pypi.org/project/streamlit-analytics2/)\n\n**Enhanced tracking & visualization for your Streamlit apps.**\n\n`streamlit-analytics2` is a fork and extension of the original [streamlit-analytics](https://github.com/jrieke/streamlit-analytics), aimed at improving and securing the analytics functionality within Streamlit applications. With minimal setup, track user interactions and visualize analytics directly in your browser, akin to Google Analytics but tailored for Streamlit.\n\nThis fork was initiated due to the inability to collaborate directly on the upstream project, which currently has several unresolved security issues and bugs. Our intention is to maintain a positive relationship with the original project and its creator, focusing on enhancing the tool's reliability and security for the community.\n\n> [!Note]\n> This fork is confirmed to fix the deprecation ```st.experimental_get_query_params``` alerts. [Context](https://docs.streamlit.io/library/api-reference/utilities/st.experimental_get_query_params) \n> It also resolved 25 security issues that exist in the upstream (2 Critical, 11 High, 10 Moderate, 2 Low) \n\n<sup>This project is in active development. We welcome contributions and address security concerns on a best-effort basis, with details available in our [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md) respectively.</sup>\n\n\n## Installation\n\n```bash\npip install streamlit-analytics2\n```\n\n## Migration from upstream streamlit-analytics\n\nOnly two single characters need to be changed and this has been tested and verified to work.\n1. Change your requirements.txt or other dependency file to use 'streamlit-analytics**2**'. Just add a '2'\n2. Change your code import to use 'streamlit_analytics**2** as streamlit_analytics'. Also, just add a '2'. Seen below.\n\n> [!IMPORTANT]\n> This project aims to be backwards compatible with the upstream and migration literally just means adding the number 2 and getting the new package. \n> The above steps should be sufficient but if you need more steps, check out our [Migration Guide](https://github.com/444B/streamlit-analytics2/wiki/0.--Migration-Guide-from-streamlit%E2%80%90analytics-to-streamlit%E2%80%90analytics2).\n\n## How to Use\n\nSimple integration with any Streamlit app:\n\n```python\nimport streamlit as st\nimport streamlit_analytics2 as streamlit_analytics\n\nwith streamlit_analytics.track():\n st.write(\"Hello, World!\")\n st.button(\"Click me\")\n```\n\nAll interactions are now tracked, supporting all standard Streamlit widgets.\n\nAnother way to get the tracking is to call the streamlit_analytics.track() on your main() function:\n```python\nimport streamlit as st\nimport streamlit_analytics2 as streamlit_analytics\n\nwith streamlit_analytics.track():\n main()\n\ndef main():\n st.write(\"Hello, World!\")\n st.button(\"Click me\")\n```\nUsing streamlit_analytics.track() is the recommended method and will become the primary way to initiate streamlit-analytics2 after the [upcoming v.1.0.0](https://github.com/444B/streamlit-analytics2/issues/53) release.\n\n## Moving Forward\n\n- **TODOs and Feature Requests**: We've transitioned our roadmap and feature requests to [GitHub Issues](https://github.com/your-repo/streamlit-analytics2/issues). Feel free to contribute ideas or report bugs! \n- **Advanced Configuration**: Detailed guidance on advanced setup (including password protection and database integration) options are available in our [Project Wiki](https://github.com/444B/streamlit-analytics2/wiki). \n- **Improved Performance**: We are focused on providing a use of streamlit-analytics2 that doesn't impact the performance of your app. \nAll suggestions and inputs are welcome on our [forum](https://github.com/444B/streamlit-analytics2/discussions)\n\n## Contributing\n\nYour contributions are welcome! Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to make a difference.\nThe step by step guide will show you how to set up a dev environment, testing standards and how to make a PR.\n\n## Security\n\nWe prioritize the security of our users' data. For reporting security vulnerabilities or for more information, please review our [SECURITY.md](SECURITY.md).\n\n## Acknowledgments\n\nA special thanks to [jrieke](https://github.com/jrieke) and all contributors to the original `streamlit-analytics` project. Your work has inspired continued innovation and community collaboration.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Johannes Rieke Copyright (c) 2024 444B 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": "Track & visualize user interactions with your streamlit app.",
"version": "0.7.2",
"project_urls": {
"Documentation": "https://github.com/444B/streamlit-analytics2/wiki",
"Issues": "https://github.com/444B/streamlit-analytics2/issues",
"Repository": "https://github.com/444B/streamlit-analytics2"
},
"split_keywords": [
"streamlit",
" analytics",
" visualization",
" streamlit-analytics",
" streamlit-analytics2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2042651d93a53324a2bec0e14cc01e46dc495ffe30493df5ab31faea39484c4",
"md5": "8799b76e2b8cb183a0561843fb71e7e8",
"sha256": "2449e9de003759d5b80998253dd7f7d725c868b1226322da659061fb9d588770"
},
"downloads": -1,
"filename": "streamlit_analytics2-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8799b76e2b8cb183a0561843fb71e7e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13654,
"upload_time": "2024-04-15T19:14:57",
"upload_time_iso_8601": "2024-04-15T19:14:57.896294Z",
"url": "https://files.pythonhosted.org/packages/f2/04/2651d93a53324a2bec0e14cc01e46dc495ffe30493df5ab31faea39484c4/streamlit_analytics2-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e4185b6f04daca5e657e2e06fa7f08f17a23ad7a6b106eae4fae41c0b114bdd",
"md5": "2d8904716aacc0a6c3b30d28dd5a882d",
"sha256": "91719a95e745e0ed19ff17f622a5adb79c51ac0afdb74cb7ba8160389af6bac7"
},
"downloads": -1,
"filename": "streamlit_analytics2-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "2d8904716aacc0a6c3b30d28dd5a882d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15112,
"upload_time": "2024-04-15T19:14:59",
"upload_time_iso_8601": "2024-04-15T19:14:59.667045Z",
"url": "https://files.pythonhosted.org/packages/5e/41/85b6f04daca5e657e2e06fa7f08f17a23ad7a6b106eae4fae41c0b114bdd/streamlit_analytics2-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 19:14:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "444B",
"github_project": "streamlit-analytics2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "streamlit-analytics2"
}
