| Name | streamlit-analytics2 JSON |
| Version |
0.10.2
JSON |
| download |
| home_page | None |
| Summary | Track & visualize user interactions with your streamlit app. |
| upload_time | 2025-01-12 23:53:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| 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 |
analytics
streamlit
streamlit-analytics
streamlit-analytics2
visualization
|
| 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/)
[](https://pepy.tech/projects/streamlit-analytics2)
[](https://pepy.tech/projects/streamlit-analytics2)
[](https://www.codefactor.io/repository/github/444b/streamlit-analytics2)
[](https://snyk.io/advisor/python/streamlit-analytics2)
## Check it out here! [👉 Demo 👈](https://sa2analyticsdemo.streamlit.app/?analytics=on)
Streamlit Analytics2 is an actively maintained, powerful tool for tracking user interactions and gathering insights from your [Streamlit](https://streamlit.io/) applications. With just a few lines of code, you can gain insight into how your app is being used and making data-driven decisions to improve your app.
> [!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 resolves 41 security issues that exist in the upstream dependencies (4 Critical, 13 High, 21 Moderate, 3 Low) as of Dec 29th 2024
## Getting Started
1. Install the package:
```
pip install streamlit-analytics2
```
2. Import and initialize the tracker in your Streamlit script:
```python
import streamlit as st
import streamlit_analytics2 as streamlit_analytics
with streamlit_analytics.track():
st.write("Hello, World!")
st.button("Click me")
```
3. Run your Streamlit app and append `?analytics=on` to the URL to view the analytics dashboard.
## Getting the most out of Streamlit Analytics2
Be sure to check out our [Wiki](https://github.com/444B/streamlit-analytics2/wiki) for even more ways to configure the application.
Some features include:
- Storing data to json, CSV or Firestore
- Gathering Session state details based on randomized UUIDs
- Setting passwords for your analytics dashboards
- Migration guides
We welcome contributions to the Wiki as well!
## Contributing
We're actively seeking additional maintainers to help improve Streamlit Analytics2. If you're interested in contributing, please check out our [Contributing Guidelines](https://github.com/444B/streamlit-analytics2/blob/main/.github/CONTRIBUTING.md) to get started. We welcome pull requests, bug reports, feature requests, and any other feedback.
## Upcoming Features
We're currently working on a major release that will introduce exciting new features and enhancements:
- Multi-page tracking: Monitor user interactions across multiple pages of your Streamlit app.
- Improved metrics accuracy: Get more precise and reliable usage metrics.
- Flexible data formats: Choose between CSV or JSON for storing and exporting analytics data.
- Customization screen: Easily configure and customize the analytics settings through a user-friendly interface.
Stay tuned for more updates and join our [community](https://github.com/444B/streamlit-analytics2/discussions) to be part of shaping the future of Streamlit Analytics2!
## Multipage tracking status:
|Method|Status|
|-|-|
|main.py|✅ (Works)|
|[pages/ directory](https://docs.streamlit.io/develop/concepts/multipage-apps/pages-directory)|❌ (Not Working)|
|[st.Page + st.navigation](https://docs.streamlit.io/develop/concepts/multipage-apps/page-and-navigation)|🤷 (Checking)|
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "streamlit-analytics2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "analytics, streamlit, streamlit-analytics, streamlit-analytics2, visualization",
"author": null,
"author_email": "444B <contact+pypi@444b.me>",
"download_url": "https://files.pythonhosted.org/packages/48/cc/eb22ae4e97eafe40435357a4885b8cef21cfa6db12642f7bca278bc91e7e/streamlit_analytics2-0.10.2.tar.gz",
"platform": null,
"description": "# Streamlit-Analytics2\n\n[](https://pypi.org/project/streamlit-analytics2/)\n[](https://pepy.tech/projects/streamlit-analytics2)\n[](https://pepy.tech/projects/streamlit-analytics2)\n\n\n[](https://www.codefactor.io/repository/github/444b/streamlit-analytics2)\n\n\n\n[](https://snyk.io/advisor/python/streamlit-analytics2)\n\n\n## Check it out here! [\ud83d\udc49 Demo \ud83d\udc48](https://sa2analyticsdemo.streamlit.app/?analytics=on)\n\nStreamlit Analytics2 is an actively maintained, powerful tool for tracking user interactions and gathering insights from your [Streamlit](https://streamlit.io/) applications. With just a few lines of code, you can gain insight into how your app is being used and making data-driven decisions to improve your app.\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 resolves 41 security issues that exist in the upstream dependencies (4 Critical, 13 High, 21 Moderate, 3 Low) as of Dec 29th 2024\n\n\n## Getting Started\n\n1. Install the package:\n ```\n pip install streamlit-analytics2\n ```\n\n2. Import and initialize the tracker in your Streamlit script:\n ```python\n import streamlit as st\n import streamlit_analytics2 as streamlit_analytics\n\n with streamlit_analytics.track():\n st.write(\"Hello, World!\")\n st.button(\"Click me\")\n ```\n\n3. Run your Streamlit app and append `?analytics=on` to the URL to view the analytics dashboard.\n\n\n## Getting the most out of Streamlit Analytics2\n\nBe sure to check out our [Wiki](https://github.com/444B/streamlit-analytics2/wiki) for even more ways to configure the application.\nSome features include:\n- Storing data to json, CSV or Firestore\n- Gathering Session state details based on randomized UUIDs\n- Setting passwords for your analytics dashboards\n- Migration guides\nWe welcome contributions to the Wiki as well!\n\n\n## Contributing\n\nWe're actively seeking additional maintainers to help improve Streamlit Analytics2. If you're interested in contributing, please check out our [Contributing Guidelines](https://github.com/444B/streamlit-analytics2/blob/main/.github/CONTRIBUTING.md) to get started. We welcome pull requests, bug reports, feature requests, and any other feedback.\n\n\n## Upcoming Features\n\nWe're currently working on a major release that will introduce exciting new features and enhancements:\n\n- Multi-page tracking: Monitor user interactions across multiple pages of your Streamlit app.\n- Improved metrics accuracy: Get more precise and reliable usage metrics.\n- Flexible data formats: Choose between CSV or JSON for storing and exporting analytics data.\n- Customization screen: Easily configure and customize the analytics settings through a user-friendly interface.\n\nStay tuned for more updates and join our [community](https://github.com/444B/streamlit-analytics2/discussions) to be part of shaping the future of Streamlit Analytics2!\n\n\n## Multipage tracking status:\n|Method|Status|\n|-|-|\n|main.py|\u2705 (Works)|\n|[pages/ directory](https://docs.streamlit.io/develop/concepts/multipage-apps/pages-directory)|\u274c (Not Working)|\n|[st.Page + st.navigation](https://docs.streamlit.io/develop/concepts/multipage-apps/page-and-navigation)|\ud83e\udd37 (Checking)|\n\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.\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.10.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": [
"analytics",
" streamlit",
" streamlit-analytics",
" streamlit-analytics2",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afafe5ee63133405353672e844252e6347ad04ddb79ebf3decf5403477345c9e",
"md5": "ba481921611524ec9b32e280c278633e",
"sha256": "50aa74e5dda8f29d4f0230ae18e252ba596032ac7d92863b640d0ddd3778ddcd"
},
"downloads": -1,
"filename": "streamlit_analytics2-0.10.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba481921611524ec9b32e280c278633e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19308,
"upload_time": "2025-01-12T23:53:15",
"upload_time_iso_8601": "2025-01-12T23:53:15.884589Z",
"url": "https://files.pythonhosted.org/packages/af/af/e5ee63133405353672e844252e6347ad04ddb79ebf3decf5403477345c9e/streamlit_analytics2-0.10.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48cceb22ae4e97eafe40435357a4885b8cef21cfa6db12642f7bca278bc91e7e",
"md5": "26d6a0f187e540391e4e9c3a75642c6c",
"sha256": "bce59b32b3f7832d86fb73040e6f7c6ece7386ef5023cfd67e9d597f60510efd"
},
"downloads": -1,
"filename": "streamlit_analytics2-0.10.2.tar.gz",
"has_sig": false,
"md5_digest": "26d6a0f187e540391e4e9c3a75642c6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16590,
"upload_time": "2025-01-12T23:53:18",
"upload_time_iso_8601": "2025-01-12T23:53:18.440838Z",
"url": "https://files.pythonhosted.org/packages/48/cc/eb22ae4e97eafe40435357a4885b8cef21cfa6db12642f7bca278bc91e7e/streamlit_analytics2-0.10.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 23:53:18",
"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"
}
