# jaclang_streamlit Plugin Documentation
The `jaclang_streamlit` plugin is a powerful tool that allows you to run and test Streamlit apps written in Jac. This documentation will guide you through the installation process and provide instructions on how to run and test your Jac Streamlit apps.
## Installation
To install the `jaclang_streamlit` plugin, you can use pip:
```shell
pip install jaclang_streamlit
```
## Running Jac Streamlit Apps
To run a Streamlit app written in Jac, you can use the following command:
```shell
jac streamlit app.jac
```
Replace `app.jac` with the path to your Jac Streamlit app file.
## Generating Graphs with Jac Streamlit
If you want to visualize the graph of your Jac Streamlit app in a browser, you can use the following command:
```shell
jac dot_view app.jac
```
This will open up a Streamlit app in your browser, displaying the graph of your Jac Streamlit app.
## Testing Jac Streamlit Apps
To test your Jac Streamlit app using the Streamlit testing framework, you can follow these steps:
1. Import the `AppTest` class from `jaclang_streamlit`:
```python
from jaclang_streamlit import AppTest
```
2. Use the `AppTest.from_jac_file(filename)` method to create an instance of `AppTest` for your Jac Streamlit app:
```python
app_test = AppTest.from_jac_file(filename)
```
Replace `filename` with the path to your Jac Streamlit app file.
3. You can now use the `app_test` instance to test your Jac Streamlit app using the Streamlit testing methodology.
Please note that the testing methodology for Jac Streamlit apps is similar to the one used for regular Streamlit apps.
Raw data
{
"_id": null,
"home_page": "https://jaseci.org",
"name": "jaclang-streamlit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.12.0",
"maintainer_email": null,
"keywords": "jac, jaclang, jaseci, streamlit, visualization, graph",
"author": "Jason Mars",
"author_email": "jason@jaseci.org",
"download_url": "https://files.pythonhosted.org/packages/5d/5a/b9e3ac3ed621632264e415d49c54ece13fa25e4f5795ceb32eaa08c762e2/jaclang_streamlit-0.0.3.tar.gz",
"platform": null,
"description": "# jaclang_streamlit Plugin Documentation\n\nThe `jaclang_streamlit` plugin is a powerful tool that allows you to run and test Streamlit apps written in Jac. This documentation will guide you through the installation process and provide instructions on how to run and test your Jac Streamlit apps.\n\n## Installation\n\nTo install the `jaclang_streamlit` plugin, you can use pip:\n\n```shell\npip install jaclang_streamlit\n```\n\n## Running Jac Streamlit Apps\n\nTo run a Streamlit app written in Jac, you can use the following command:\n\n```shell\njac streamlit app.jac\n```\n\nReplace `app.jac` with the path to your Jac Streamlit app file.\n\n## Generating Graphs with Jac Streamlit\n\nIf you want to visualize the graph of your Jac Streamlit app in a browser, you can use the following command:\n\n```shell\njac dot_view app.jac\n```\n\nThis will open up a Streamlit app in your browser, displaying the graph of your Jac Streamlit app.\n\n## Testing Jac Streamlit Apps\n\nTo test your Jac Streamlit app using the Streamlit testing framework, you can follow these steps:\n\n1. Import the `AppTest` class from `jaclang_streamlit`:\n\n```python\nfrom jaclang_streamlit import AppTest\n```\n\n2. Use the `AppTest.from_jac_file(filename)` method to create an instance of `AppTest` for your Jac Streamlit app:\n\n```python\napp_test = AppTest.from_jac_file(filename)\n```\n\nReplace `filename` with the path to your Jac Streamlit app file.\n\n3. You can now use the `app_test` instance to test your Jac Streamlit app using the Streamlit testing methodology.\n\nPlease note that the testing methodology for Jac Streamlit apps is similar to the one used for regular Streamlit apps.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This Jac plugin adds a streamlit command line option for conveniently running streamlit apps written in Jac.",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://jac-lang.org",
"Homepage": "https://jaseci.org",
"Repository": "https://github.com/Jaseci-Labs/jaclang"
},
"split_keywords": [
"jac",
" jaclang",
" jaseci",
" streamlit",
" visualization",
" graph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2e8a7da7c3aec0fb050cf01b6cde71614583446d4f210ce88ba18d5ec16837c",
"md5": "2058d43948b1859d9564f87807510af9",
"sha256": "853a7927362fd0c2b1a959c626b304e47d40d2f7e82c3747cc0cba2dad67dd17"
},
"downloads": -1,
"filename": "jaclang_streamlit-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2058d43948b1859d9564f87807510af9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.12.0",
"size": 5061,
"upload_time": "2024-08-31T20:16:22",
"upload_time_iso_8601": "2024-08-31T20:16:22.728815Z",
"url": "https://files.pythonhosted.org/packages/e2/e8/a7da7c3aec0fb050cf01b6cde71614583446d4f210ce88ba18d5ec16837c/jaclang_streamlit-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d5ab9e3ac3ed621632264e415d49c54ece13fa25e4f5795ceb32eaa08c762e2",
"md5": "1c0d55246ba7abcac61c58511e592ce9",
"sha256": "554537cd44624c2735947fa03097e29848559aec9280af7454985d22c31134a4"
},
"downloads": -1,
"filename": "jaclang_streamlit-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "1c0d55246ba7abcac61c58511e592ce9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.12.0",
"size": 3638,
"upload_time": "2024-08-31T20:16:24",
"upload_time_iso_8601": "2024-08-31T20:16:24.227932Z",
"url": "https://files.pythonhosted.org/packages/5d/5a/b9e3ac3ed621632264e415d49c54ece13fa25e4f5795ceb32eaa08c762e2/jaclang_streamlit-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 20:16:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Jaseci-Labs",
"github_project": "jaclang",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jaclang-streamlit"
}
JSON
