| Name | shiny-semantic JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Semantic UI components in Shiny for Python |
| upload_time | 2023-01-20 14:59:52 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. |
| keywords |
shiny
semantic
web
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Semantic UI in Shiny-for-Python
_Create rich web applications in PyShiny using styles and components from Semantic UI._
## Demo applications and examples
- Semantic Components Showcase
- [Live Demo](https://connect.appsilon.com/py_shiny_semantic/)
- [Source Code](https://github.com/Appsilon/py_shiny_semantic_examples/tree/main/semantic-components)
- T-Test Simulation Clone
- [Live Demo](https://connect.appsilon.com/py_shiny_ttest)
- [Source Code](https://github.com/Appsilon/py_shiny_semantic_examples/tree/main/semantic-ttest)
## About the project
This is an early [Shiny-for-Python](https://shiny.rstudio.com/py/) implementation of [the official community fork of Semantic UI](https://fomantic-ui.com/).
The repository contains a python package `shiny_semantic` and a PyShiny application (found in `example` folder) that serves as a simple demo of the implemented components.
The application is deployed on RSConnect and can be found at https://connect.appsilon.com/py_shiny_semantic/.
## About Fomantic UI
[Fomantic UI](https://fomantic-ui.com/) is a well-maintained community fork of a more widely known and mature [Semantic UI](https://semantic-ui.com/). This project uses JS, CSS and icons from Fomantic UI while referring to the name of the original library.
The structure of `shiny_semantic` follows the one of Fomantic UI -- this way users may easily refer to corresponding sections in the original documentation to learn about possible classes, styles and behaviors of the components.
## How to install
`shiny_semantic` is available from the official [PyPI distribution](https://pypi.org/project/shiny-semantic), and can be installed using pip. Please remember, that it is considered to be best practice to install packages in isolated virtual environments (see the next section).
```
pip install shiny_semantic
```
This will install both `shiny` and `shiny_semantic` - it is enough to start creating a Shiny application in Python.
## Development
In this project we used only those python tools that already come with a standard python distribution and should be immediately available to the developers. For package management we used `pip`, for virtual environment we used `venv`, and for unit tests we used `unittest`.
Please note, that some systems (e.g. macOS) have Python installed by default, and it may be accessible with `python3` rather than just `python`. As soon as you init and source a venv, you will be able to call python with just `python`.
To start development, run the following command:
```shell
python -m venv .venv # creates virtual environment
source .venv/bin/activate # activates virtual environment
pip install -e ".[dev]
```
This project uses [pre-commit](https://pre-commit.com/) to ensure the quality of code style. Once the dependencies are restored, run the following command once:
```shell
pre-commit install
```
To run the app in the hot-reload mode (the app automatically reloads every time it detects changes in the python source code), run the following command:
```
shiny run --reload example
```
## How to update the package
This project leverages [bumpver](https://github.com/mbarkhau/bumpver) to handle package versioning. To make sure that `bumpver` works, run the following commands:
```shell
pip install bumpver
bumpver update --patch --dry --no-fetch
```
This should provide the developer with a preview of changed lines across multiple files - where package version is mentioned. When local updates are fininshed, the developer might run:
```shell
bumpver update --patch # or --minor or --major, depending on the PR goal
```
This command will change the abovementioned string versions, create a commit with "bump version" message, create a git tag and will push changes to the remote. Developers will find a new version under "Releases" section on the Github page.
## How to build and publish the package
```shell
pip install build twine
# It is best to remove local dist folder, so that `twine` is not confused on which version to use
rm -rf dist
python -m build
twine check dist/*
# Currently, the package is published by pavel.demin@appsilon.com
twine upload dist/*
```
## How to update the Fomantic components
The easiest way to replace the Fomantic assets with the new ones, is as follows:
1. Navigate to https://www.jsdelivr.com/package/npm/fomantic-ui. This resource is recommended by the Fomantic team - it contains the latest version of the library files
2. Download the entire folder as a _.tgz_ archive
3. Unpack the archive
4. Find _dist_ folder, grab the minimized versions of CSS and JS files and move them into _shiny_semantic/www/semantic/_
5. In the same _dist_ folder, locate the _themes_ subfolder - open it
6. Move the _default_ folder into _shiny_semantic/www/semantic/themes_ - this way Fomantic JS and CSS will be able to seamlessly pick up fonts and icons.
Raw data
{
"_id": null,
"home_page": "",
"name": "shiny-semantic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Appsilon <opensource@appsilon.com>",
"keywords": "shiny,semantic,web",
"author": "",
"author_email": "Pavel Demin <pavel.demin@appsilon.com>, Kamil \u017by\u0142a <kamil@appsilon.com>",
"download_url": "https://files.pythonhosted.org/packages/40/25/016248a11dc01fb77e31906ce466d9442178cdc35de844f14e7dc4b01282/shiny_semantic-0.1.3.tar.gz",
"platform": null,
"description": "# Semantic UI in Shiny-for-Python\n\n\n\n_Create rich web applications in PyShiny using styles and components from Semantic UI._\n\n## Demo applications and examples\n\n- Semantic Components Showcase\n - [Live Demo](https://connect.appsilon.com/py_shiny_semantic/)\n - [Source Code](https://github.com/Appsilon/py_shiny_semantic_examples/tree/main/semantic-components)\n- T-Test Simulation Clone\n - [Live Demo](https://connect.appsilon.com/py_shiny_ttest)\n - [Source Code](https://github.com/Appsilon/py_shiny_semantic_examples/tree/main/semantic-ttest)\n\n## About the project\n\nThis is an early [Shiny-for-Python](https://shiny.rstudio.com/py/) implementation of [the official community fork of Semantic UI](https://fomantic-ui.com/).\n\nThe repository contains a python package `shiny_semantic` and a PyShiny application (found in `example` folder) that serves as a simple demo of the implemented components.\n\nThe application is deployed on RSConnect and can be found at https://connect.appsilon.com/py_shiny_semantic/.\n\n## About Fomantic UI\n\n[Fomantic UI](https://fomantic-ui.com/) is a well-maintained community fork of a more widely known and mature [Semantic UI](https://semantic-ui.com/). This project uses JS, CSS and icons from Fomantic UI while referring to the name of the original library.\n\nThe structure of `shiny_semantic` follows the one of Fomantic UI -- this way users may easily refer to corresponding sections in the original documentation to learn about possible classes, styles and behaviors of the components.\n\n## How to install\n\n`shiny_semantic` is available from the official [PyPI distribution](https://pypi.org/project/shiny-semantic), and can be installed using pip. Please remember, that it is considered to be best practice to install packages in isolated virtual environments (see the next section).\n\n```\npip install shiny_semantic\n```\n\nThis will install both `shiny` and `shiny_semantic` - it is enough to start creating a Shiny application in Python.\n\n## Development\n\nIn this project we used only those python tools that already come with a standard python distribution and should be immediately available to the developers. For package management we used `pip`, for virtual environment we used `venv`, and for unit tests we used `unittest`.\n\nPlease note, that some systems (e.g. macOS) have Python installed by default, and it may be accessible with `python3` rather than just `python`. As soon as you init and source a venv, you will be able to call python with just `python`.\n\nTo start development, run the following command:\n\n```shell\npython -m venv .venv # creates virtual environment\nsource .venv/bin/activate # activates virtual environment\npip install -e \".[dev]\n```\n\nThis project uses [pre-commit](https://pre-commit.com/) to ensure the quality of code style. Once the dependencies are restored, run the following command once:\n\n```shell\npre-commit install\n```\n\nTo run the app in the hot-reload mode (the app automatically reloads every time it detects changes in the python source code), run the following command:\n\n```\nshiny run --reload example\n```\n\n## How to update the package\n\nThis project leverages [bumpver](https://github.com/mbarkhau/bumpver) to handle package versioning. To make sure that `bumpver` works, run the following commands:\n\n```shell\npip install bumpver\nbumpver update --patch --dry --no-fetch\n```\n\nThis should provide the developer with a preview of changed lines across multiple files - where package version is mentioned. When local updates are fininshed, the developer might run:\n\n```shell\nbumpver update --patch # or --minor or --major, depending on the PR goal\n```\n\nThis command will change the abovementioned string versions, create a commit with \"bump version\" message, create a git tag and will push changes to the remote. Developers will find a new version under \"Releases\" section on the Github page.\n\n## How to build and publish the package\n\n```shell\npip install build twine\n\n# It is best to remove local dist folder, so that `twine` is not confused on which version to use\nrm -rf dist\n\npython -m build\ntwine check dist/*\n\n# Currently, the package is published by pavel.demin@appsilon.com\ntwine upload dist/*\n```\n\n## How to update the Fomantic components\n\nThe easiest way to replace the Fomantic assets with the new ones, is as follows:\n\n1. Navigate to https://www.jsdelivr.com/package/npm/fomantic-ui. This resource is recommended by the Fomantic team - it contains the latest version of the library files\n2. Download the entire folder as a _.tgz_ archive\n3. Unpack the archive\n4. Find _dist_ folder, grab the minimized versions of CSS and JS files and move them into _shiny_semantic/www/semantic/_\n5. In the same _dist_ folder, locate the _themes_ subfolder - open it\n6. Move the _default_ folder into _shiny_semantic/www/semantic/themes_ - this way Fomantic JS and CSS will be able to seamlessly pick up fonts and icons.\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, \"this License\" refers to version 3 of the GNU Lesser General Public License, and the \"GNU GPL\" refers to version 3 of the GNU General Public License. \"The Library\" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An \"Application\" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A \"Combined Work\" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the \"Linked Version\". The \"Minimal Corresponding Source\" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The \"Corresponding Application Code\" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ",
"summary": "Semantic UI components in Shiny for Python",
"version": "0.1.3",
"split_keywords": [
"shiny",
"semantic",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd1c89aa57d6b1ca5421d4a6f8207095129aab116ba0ed9bed59a8b9f5b379df",
"md5": "61889f73c5b3107619e955381691928a",
"sha256": "404e7d3496a1f2a15eb94b4fd25a543f3b502466223b0e7c2220aef3eb4d2e0a"
},
"downloads": -1,
"filename": "shiny_semantic-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61889f73c5b3107619e955381691928a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3004090,
"upload_time": "2023-01-20T14:59:45",
"upload_time_iso_8601": "2023-01-20T14:59:45.442887Z",
"url": "https://files.pythonhosted.org/packages/bd/1c/89aa57d6b1ca5421d4a6f8207095129aab116ba0ed9bed59a8b9f5b379df/shiny_semantic-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4025016248a11dc01fb77e31906ce466d9442178cdc35de844f14e7dc4b01282",
"md5": "6d8a94bc6df13a2d2509a5a449ff307b",
"sha256": "a00b572b2a61d32944ee546fee743e8ecb7166b60e99f3c88d38181dec9f7b37"
},
"downloads": -1,
"filename": "shiny_semantic-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6d8a94bc6df13a2d2509a5a449ff307b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 2996447,
"upload_time": "2023-01-20T14:59:52",
"upload_time_iso_8601": "2023-01-20T14:59:52.853463Z",
"url": "https://files.pythonhosted.org/packages/40/25/016248a11dc01fb77e31906ce466d9442178cdc35de844f14e7dc4b01282/shiny_semantic-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-20 14:59:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "shiny-semantic"
}
