# QueryParams Widgets for Streamlit
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/asaurus1/streamlit-qs/pdm.yml)](https://github.com/Asaurus1/streamlit-qs/actions)
[![GitHub last commit](https://img.shields.io/github/last-commit/asaurus1/streamlit-qs)](https://github.com/Asaurus1/streamlit-qs)
[![PyPI - Version](https://img.shields.io/pypi/v/streamlit-qs)](https://pypi.org/project/streamlit-qs/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/streamlit-qs)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/streamlit-qs)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/streamlit-qs)
![PyPI - Downloads](https://img.shields.io/pypi/dm/streamlit-qs)
[![Licence](https://img.shields.io/badge/licence-Apache%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)
[![Streamlit Version](https://img.shields.io/badge/Streamlit->=1.30.0-blue)](https://github.com/streamlit/streamlit)
[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org)
The functions in this library allow you to easily create "permalink-like" functionality in your application,
This can let users to share links with others that will populate streamlit with the same set of input values
that they were using. Or you can use the query string to pass data into your streamlit application from
another website or program.
## Installation
First install Streamlit (of course!) then install this library:
```bash
pip install streamlit-qs
```
Or, to install the latest source:
```bash
pip install git+https://github.com/Asaurus1/streamlit-qs.git@main
```
## Example
```python
import streamlit as st
import streamlit_qs as stqs
st.markdown("[Click this URL](?input_some_text=Hello+World)")
stqs.text_input_qs("Enter Some Text", key="input_some_text")
```
For more examples, including :sparkles:**customization options**:sparkles:, see
[the demo app](https://query-string.streamlit.app/).
## Version Compatibility
For Streamlit v1.29.0 or below use release v0.2.0 of this app
For Streamlit v1.30.0 or above, use the latest released version of this app above v0.2.0
Raw data
{
"_id": null,
"home_page": null,
"name": "streamlit-qs",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.9.7,>=3.8",
"maintainer_email": null,
"keywords": "streamlit, query, url, query_params, widgets, extension, community, permalink, state, save, data",
"author": null,
"author_email": "Alexander Martin <fauxjunk-1@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/a2/25/a9d9ebe4f7f4a1c2c1c4f8d43036ebe7489d7cb90afefbed8a182c17af52/streamlit_qs-0.3.3.tar.gz",
"platform": null,
"description": "# QueryParams Widgets for Streamlit\n\n[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/asaurus1/streamlit-qs/pdm.yml)](https://github.com/Asaurus1/streamlit-qs/actions)\n[![GitHub last commit](https://img.shields.io/github/last-commit/asaurus1/streamlit-qs)](https://github.com/Asaurus1/streamlit-qs)\n[![PyPI - Version](https://img.shields.io/pypi/v/streamlit-qs)](https://pypi.org/project/streamlit-qs/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/streamlit-qs)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/streamlit-qs)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/streamlit-qs)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/streamlit-qs)\n[![Licence](https://img.shields.io/badge/licence-Apache%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Streamlit Version](https://img.shields.io/badge/Streamlit->=1.30.0-blue)](https://github.com/streamlit/streamlit)\n[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org)\n\nThe functions in this library allow you to easily create \"permalink-like\" functionality in your application,\nThis can let users to share links with others that will populate streamlit with the same set of input values\nthat they were using. Or you can use the query string to pass data into your streamlit application from\nanother website or program.\n\n\n## Installation\n\nFirst install Streamlit (of course!) then install this library:\n\n```bash\npip install streamlit-qs\n```\nOr, to install the latest source:\n```bash\npip install git+https://github.com/Asaurus1/streamlit-qs.git@main\n```\n\n## Example\n\n```python\nimport streamlit as st\nimport streamlit_qs as stqs\n\nst.markdown(\"[Click this URL](?input_some_text=Hello+World)\") \nstqs.text_input_qs(\"Enter Some Text\", key=\"input_some_text\")\n```\n\nFor more examples, including :sparkles:**customization options**:sparkles:, see\n[the demo app](https://query-string.streamlit.app/).\n\n\n## Version Compatibility\nFor Streamlit v1.29.0 or below use release v0.2.0 of this app\nFor Streamlit v1.30.0 or above, use the latest released version of this app above v0.2.0\n",
"bugtrack_url": null,
"license": null,
"summary": "A small library to add extra functionality on top of streamlit's st.query_params API",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://query-string.streamlit.app/",
"Issues": "https://github.com/Asaurus1/streamlit-qs/issues",
"Repository": "https://github.com/Asaurus1/streamlit-qs"
},
"split_keywords": [
"streamlit",
" query",
" url",
" query_params",
" widgets",
" extension",
" community",
" permalink",
" state",
" save",
" data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0be993d59a2907f5e62f417bbe75e157c0c02baa76e90dc4457e4469c45cf53",
"md5": "c913b44b5bc318d2cec7751d072d6b01",
"sha256": "31c6e0e4f8d31ba7e799c0445b2f33f38fcde2814db53c696d84faab444de8cf"
},
"downloads": -1,
"filename": "streamlit_qs-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c913b44b5bc318d2cec7751d072d6b01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=3.9.7,>=3.8",
"size": 13812,
"upload_time": "2024-05-25T03:23:38",
"upload_time_iso_8601": "2024-05-25T03:23:38.336814Z",
"url": "https://files.pythonhosted.org/packages/f0/be/993d59a2907f5e62f417bbe75e157c0c02baa76e90dc4457e4469c45cf53/streamlit_qs-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a225a9d9ebe4f7f4a1c2c1c4f8d43036ebe7489d7cb90afefbed8a182c17af52",
"md5": "69890d901ffe76ceb4aa2c38d74b026b",
"sha256": "aac40b8fd7f20b5393658576a40de2bfef1ffbab5d9dc1ec145038b992d1d15b"
},
"downloads": -1,
"filename": "streamlit_qs-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "69890d901ffe76ceb4aa2c38d74b026b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.9.7,>=3.8",
"size": 18620,
"upload_time": "2024-05-25T03:23:40",
"upload_time_iso_8601": "2024-05-25T03:23:40.012766Z",
"url": "https://files.pythonhosted.org/packages/a2/25/a9d9ebe4f7f4a1c2c1c4f8d43036ebe7489d7cb90afefbed8a182c17af52/streamlit_qs-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-25 03:23:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Asaurus1",
"github_project": "streamlit-qs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "streamlit-qs"
}