| Name | streamlit-carousel JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | https://github.com/thomasbs17/streamlit-contributions/bootstrap_carousel |
| Summary | A Streamlit implementation of the React Bootstrap Carousel component. |
| upload_time | 2024-04-25 23:59:18 |
| maintainer | None |
| docs_url | None |
| author | Thomas Bouamoud |
| requires_python | >=3.6 |
| license | Copyright (c) 2023 Thomas Bouamoud 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 |
python
streamlit
react
bootstrap
carousel
gallery
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Streamlit Carousel
Streamlit Carousel is a Python package that provides a custom component for integrating the React Bootstrap Carousel into Streamlit applications.
## Installation
To install streamlit_carousel, use the following command:
```shell
pip install streamlit-carousel
```
## Usage
Once installed, you can use the streamlit_carousel component in your Streamlit application. Here's an example:
```python
from streamlit_carousel import carousel
test_items = [
dict(
title="Slide 1",
text="A tree in the savannah",
img="https://img.freepik.com/free-photo/wide-angle-shot-single-tree-growing-clouded-sky-during-sunset-surrounded-by-grass_181624-22807.jpg?w=1380&t=st=1688825493~exp=1688826093~hmac=cb486d2646b48acbd5a49a32b02bda8330ad7f8a0d53880ce2da471a45ad08a4",
link="https://discuss.streamlit.io/t/new-component-react-bootstrap-carousel/46819"
),
dict(
title="Slide 2",
text="A wooden bridge in a forest in Autumn",
img="https://img.freepik.com/free-photo/beautiful-wooden-pathway-going-breathtaking-colorful-trees-forest_181624-5840.jpg?w=1380&t=st=1688825780~exp=1688826380~hmac=dbaa75d8743e501f20f0e820fa77f9e377ec5d558d06635bd3f1f08443bdb2c1",
link="https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel"
),
dict(
title="Slide 3",
text="A distant mountain chain preceded by a sea",
img="https://img.freepik.com/free-photo/aerial-beautiful-shot-seashore-with-hills-background-sunset_181624-24143.jpg?w=1380&t=st=1688825798~exp=1688826398~hmac=f623f88d5ece83600dac7e6af29a0230d06619f7305745db387481a4bb5874a0",
link="https://github.com/thomasbs17/streamlit-contributions/tree/master"
),
]
carousel(items=test_items, width=0.5)
```
Please note that the images provided should be the path or URL to the image files.
## Known issues
- If an item's text is too long, it overflows on other items
## Contributing
Contributions to Streamlit Carousel are welcome! If you find any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel). If you'd like to contribute code, you can fork the repository, make your changes, and submit a pull request.
Before contributing, please review the [Contributing Guidelines](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel/README.md) for more information.
## License
This package is licensed under the MIT License. See the [LICENSE file](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel/LICENSE) for more information.
## Credits
Streamlit Carousel is created and maintained by Thomas Bouamoud.
It leverages the [React Bootstrap Carousel component](https://react-bootstrap.netlify.app/docs/components/carousel/) and utilizes the Streamlit Custom Components feature.
## Contact
If you have any questions or inquiries, feel free to reach out to thomas.bouamoud@gmail.com.
Raw data
{
"_id": null,
"home_page": "https://github.com/thomasbs17/streamlit-contributions/bootstrap_carousel",
"name": "streamlit-carousel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "python, streamlit, react, bootstrap, carousel, gallery",
"author": "Thomas Bouamoud",
"author_email": "Thomas Bouamoud <thomas.bouamoud@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/95/5b/4bfda5482c42355b6766e108eea00b00767ed4160e81ec9a9d2caf89abc1/streamlit_carousel-1.0.0.tar.gz",
"platform": null,
"description": "# Streamlit Carousel\r\n\r\nStreamlit Carousel is a Python package that provides a custom component for integrating the React Bootstrap Carousel into Streamlit applications.\r\n\r\n## Installation\r\n\r\nTo install streamlit_carousel, use the following command:\r\n\r\n```shell\r\npip install streamlit-carousel\r\n```\r\n\r\n## Usage\r\n\r\nOnce installed, you can use the streamlit_carousel component in your Streamlit application. Here's an example:\r\n\r\n```python\r\nfrom streamlit_carousel import carousel\r\n\r\ntest_items = [\r\n dict(\r\n title=\"Slide 1\",\r\n text=\"A tree in the savannah\",\r\n img=\"https://img.freepik.com/free-photo/wide-angle-shot-single-tree-growing-clouded-sky-during-sunset-surrounded-by-grass_181624-22807.jpg?w=1380&t=st=1688825493~exp=1688826093~hmac=cb486d2646b48acbd5a49a32b02bda8330ad7f8a0d53880ce2da471a45ad08a4\",\r\n link=\"https://discuss.streamlit.io/t/new-component-react-bootstrap-carousel/46819\"\r\n ),\r\n dict(\r\n title=\"Slide 2\",\r\n text=\"A wooden bridge in a forest in Autumn\",\r\n img=\"https://img.freepik.com/free-photo/beautiful-wooden-pathway-going-breathtaking-colorful-trees-forest_181624-5840.jpg?w=1380&t=st=1688825780~exp=1688826380~hmac=dbaa75d8743e501f20f0e820fa77f9e377ec5d558d06635bd3f1f08443bdb2c1\",\r\n link=\"https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel\"\r\n ),\r\n dict(\r\n title=\"Slide 3\",\r\n text=\"A distant mountain chain preceded by a sea\",\r\n img=\"https://img.freepik.com/free-photo/aerial-beautiful-shot-seashore-with-hills-background-sunset_181624-24143.jpg?w=1380&t=st=1688825798~exp=1688826398~hmac=f623f88d5ece83600dac7e6af29a0230d06619f7305745db387481a4bb5874a0\",\r\n link=\"https://github.com/thomasbs17/streamlit-contributions/tree/master\"\r\n ),\r\n]\r\n\r\ncarousel(items=test_items, width=0.5)\r\n\r\n```\r\n\r\nPlease note that the images provided should be the path or URL to the image files.\r\n\r\n## Known issues\r\n- If an item's text is too long, it overflows on other items\r\n\r\n## Contributing\r\nContributions to Streamlit Carousel are welcome! If you find any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel). If you'd like to contribute code, you can fork the repository, make your changes, and submit a pull request.\r\n\r\nBefore contributing, please review the [Contributing Guidelines](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel/README.md) for more information.\r\n\r\n## License\r\nThis package is licensed under the MIT License. See the [LICENSE file](https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel/LICENSE) for more information.\r\n\r\n## Credits\r\nStreamlit Carousel is created and maintained by Thomas Bouamoud. \r\nIt leverages the [React Bootstrap Carousel component](https://react-bootstrap.netlify.app/docs/components/carousel/) and utilizes the Streamlit Custom Components feature.\r\n\r\n## Contact\r\nIf you have any questions or inquiries, feel free to reach out to thomas.bouamoud@gmail.com.\r\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023 Thomas Bouamoud 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": "A Streamlit implementation of the React Bootstrap Carousel component.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/thomasbs17/streamlit-contributions/tree/master/bootstrap_carousel"
},
"split_keywords": [
"python",
" streamlit",
" react",
" bootstrap",
" carousel",
" gallery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13a543487ecaa72a6777d5a6eafa6c80b39b17a0aaa57f588d5abe5eac013e33",
"md5": "5f81c5fed4a304e3508fd4126214e206",
"sha256": "3cd190b5b8c340b87e2b293cf6461123b7002cc4766afe11d60adbbb3ec587d6"
},
"downloads": -1,
"filename": "streamlit_carousel-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f81c5fed4a304e3508fd4126214e206",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 563367,
"upload_time": "2024-04-25T23:59:15",
"upload_time_iso_8601": "2024-04-25T23:59:15.919574Z",
"url": "https://files.pythonhosted.org/packages/13/a5/43487ecaa72a6777d5a6eafa6c80b39b17a0aaa57f588d5abe5eac013e33/streamlit_carousel-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "955b4bfda5482c42355b6766e108eea00b00767ed4160e81ec9a9d2caf89abc1",
"md5": "43ef14672e0dddc73ac53c1d87aef5b0",
"sha256": "1643efd927961b5b966e47d495e60f831f59ad263cab12e7a1eda7313459ac6f"
},
"downloads": -1,
"filename": "streamlit_carousel-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "43ef14672e0dddc73ac53c1d87aef5b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 559663,
"upload_time": "2024-04-25T23:59:18",
"upload_time_iso_8601": "2024-04-25T23:59:18.198829Z",
"url": "https://files.pythonhosted.org/packages/95/5b/4bfda5482c42355b6766e108eea00b00767ed4160e81ec9a9d2caf89abc1/streamlit_carousel-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 23:59:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thomasbs17",
"github_project": "streamlit-contributions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "streamlit-carousel"
}
