Name | sigmaepsilon.plotting.plotly JSON |
Version |
1.0.0
JSON |
| download |
home_page | |
Summary | Utilities for plotting with Plotly. |
upload_time | 2023-08-10 11:59:37 |
maintainer | |
docs_url | None |
author | |
requires_python | <3.11,>=3.7 |
license | MIT License Copyright (c) 2023 SigmaEpsilon 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 |
engineering
mechanics
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# **SigmaEpsilon.Plotting.Plotly** - Utilities for plotting with Plotly
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/sigma-epsilon/sigmaepsilon.plotting.plotly/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/sigma-epsilon/sigmaepsilon.plotting.plotly/tree/main)
[![Documentation Status](https://readthedocs.org/projects/sigmaepsilonplottingplotly/badge/?version=latest)](https://sigmaepsilonplottingplotly.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://badge.fury.io/py/sigmaepsilon.plotting.plotly.svg)](https://pypi.org/project/sigmaepsilon.plotting.plotly)
[![Python 3.7‒3.10](https://img.shields.io/badge/python-3.7%E2%80%923.10-blue)](https://www.python.org)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
The library serves as a repo for plots that are not directly available from Plotly but might be useful outside the scope of what they were originally created for.
## Projects using sigmaepsilon.plotting.plotly
* [PyAxisVM](https://github.com/AxisVM/pyaxisvm) - The official Python package of [AxisVM](https://axisvm.eu/), a popular structural analysis and design software.
## Documentation
The [documentation](https://sigmaepsilonplottingplotly.readthedocs.io/en/latest/) is built with [Sphinx](https://www.sphinx-doc.org/en/master/) using the [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html) and hosted on [ReadTheDocs](https://readthedocs.org/). Check it out for an ever growing set of examples, and API Reference.
## Installation
sigmaepsilon.plotting.plotly can be installed from PyPI using `pip` on Python >= 3.7:
```console
>>> pip install sigmaepsilon.plotting.plotly
```
or chechkout with the following command using GitHub CLI
```console
gh repo clone sigma-epsilon/sigmaepsilon.plotting.plotly
```
and install from source by typing
```console
>>> pip install .
```
If you want to run the tests, you can install the package along with the necessary optional dependencies like this
```console
>>> pip install ".[test]"
```
### Development mode
If you are a developer and want to install the library in development mode, the suggested way is by using this command:
```console
>>> pip install "-e .[test, dev]"
```
If you plan to touch the docs, you can install the requirements for that as well:
```console
>>> pip install "-e .[test, dev, docs]"
```
## How to contribute?
Contributions are currently expected in any the following ways:
* finding bugs
If you run into trouble when using the library and you think it is a bug, feel free to raise an issue.
* feedback
All kinds of ideas are welcome. For instance if you feel like something is still shady (after reading the user guide), we want to know. Be gentle though, the development of the library is financially not supported yet.
* feature requests
Tell us what you think is missing (with realistic expectations).
* examples
If you've done something with the library and you think that it would make for a good example, get in touch with the developers and we will happily inlude it in the documention.
* sharing is caring
If you like the library, share it with your friends or colleagues so they can like it too.
## License
This package is licensed under the [MIT license](https://opensource.org/license/mit/).
Raw data
{
"_id": null,
"home_page": "",
"name": "sigmaepsilon.plotting.plotly",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.11,>=3.7",
"maintainer_email": "SigmaEpsilon <bencebalogh@sigmaepsilon.com>",
"keywords": "engineering,mechanics",
"author": "",
"author_email": "SigmaEpsilon <bencebalogh@sigmaepsilon.com>",
"download_url": "https://files.pythonhosted.org/packages/97/79/04c5ace954dfa34cd34dea56f4e4a3d2ba04027a44ca3de43735985267ee/sigmaepsilon.plotting.plotly-1.0.0.tar.gz",
"platform": null,
"description": "# **SigmaEpsilon.Plotting.Plotly** - Utilities for plotting with Plotly\r\n\r\n[![CircleCI](https://dl.circleci.com/status-badge/img/gh/sigma-epsilon/sigmaepsilon.plotting.plotly/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/sigma-epsilon/sigmaepsilon.plotting.plotly/tree/main)\r\n[![Documentation Status](https://readthedocs.org/projects/sigmaepsilonplottingplotly/badge/?version=latest)](https://sigmaepsilonplottingplotly.readthedocs.io/en/latest/?badge=latest)\r\n[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n[![PyPI](https://badge.fury.io/py/sigmaepsilon.plotting.plotly.svg)](https://pypi.org/project/sigmaepsilon.plotting.plotly)\r\n[![Python 3.7\u20123.10](https://img.shields.io/badge/python-3.7%E2%80%923.10-blue)](https://www.python.org)\r\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\r\n\r\nThe library serves as a repo for plots that are not directly available from Plotly but might be useful outside the scope of what they were originally created for.\r\n\r\n## Projects using sigmaepsilon.plotting.plotly\r\n\r\n* [PyAxisVM](https://github.com/AxisVM/pyaxisvm) - The official Python package of [AxisVM](https://axisvm.eu/), a popular structural analysis and design software.\r\n\r\n## Documentation\r\n\r\nThe [documentation](https://sigmaepsilonplottingplotly.readthedocs.io/en/latest/) is built with [Sphinx](https://www.sphinx-doc.org/en/master/) using the [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html) and hosted on [ReadTheDocs](https://readthedocs.org/). Check it out for an ever growing set of examples, and API Reference.\r\n\r\n## Installation\r\n\r\nsigmaepsilon.plotting.plotly can be installed from PyPI using `pip` on Python >= 3.7:\r\n\r\n```console\r\n>>> pip install sigmaepsilon.plotting.plotly\r\n```\r\n\r\nor chechkout with the following command using GitHub CLI\r\n\r\n```console\r\ngh repo clone sigma-epsilon/sigmaepsilon.plotting.plotly\r\n```\r\n\r\nand install from source by typing\r\n\r\n```console\r\n>>> pip install .\r\n```\r\n\r\nIf you want to run the tests, you can install the package along with the necessary optional dependencies like this\r\n\r\n```console\r\n>>> pip install \".[test]\"\r\n```\r\n\r\n### Development mode\r\n\r\nIf you are a developer and want to install the library in development mode, the suggested way is by using this command:\r\n\r\n```console\r\n>>> pip install \"-e .[test, dev]\"\r\n```\r\n\r\nIf you plan to touch the docs, you can install the requirements for that as well:\r\n\r\n```console\r\n>>> pip install \"-e .[test, dev, docs]\"\r\n```\r\n\r\n## How to contribute?\r\n\r\nContributions are currently expected in any the following ways:\r\n\r\n* finding bugs\r\n If you run into trouble when using the library and you think it is a bug, feel free to raise an issue.\r\n* feedback\r\n All kinds of ideas are welcome. For instance if you feel like something is still shady (after reading the user guide), we want to know. Be gentle though, the development of the library is financially not supported yet.\r\n* feature requests\r\n Tell us what you think is missing (with realistic expectations).\r\n* examples\r\n If you've done something with the library and you think that it would make for a good example, get in touch with the developers and we will happily inlude it in the documention.\r\n* sharing is caring\r\n If you like the library, share it with your friends or colleagues so they can like it too.\r\n\r\n## License\r\n\r\nThis package is licensed under the [MIT license](https://opensource.org/license/mit/).\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 SigmaEpsilon 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": "Utilities for plotting with Plotly.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/sigma-epsilon/sigmaepsilon.plotting.plotly"
},
"split_keywords": [
"engineering",
"mechanics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64b95b2452b95e0d597e26b47ab74832f6ac2c5ec78f53fe187aad2154738cc0",
"md5": "cc2e1eabc2956c98d599c0f8e4a99b56",
"sha256": "afd80fe330c709b0fa6eab1d33a0511ba7c37575b9fd548ccbd6ae92da0ea321"
},
"downloads": -1,
"filename": "sigmaepsilon.plotting.plotly-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc2e1eabc2956c98d599c0f8e4a99b56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.7",
"size": 7982,
"upload_time": "2023-08-10T11:59:35",
"upload_time_iso_8601": "2023-08-10T11:59:35.381107Z",
"url": "https://files.pythonhosted.org/packages/64/b9/5b2452b95e0d597e26b47ab74832f6ac2c5ec78f53fe187aad2154738cc0/sigmaepsilon.plotting.plotly-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "977904c5ace954dfa34cd34dea56f4e4a3d2ba04027a44ca3de43735985267ee",
"md5": "aa54b6f8231653eb814e20f0e8268212",
"sha256": "bb8759f590239e421047a0c489f5e5a692bcbc62648f384cb7b0d8d8853d7544"
},
"downloads": -1,
"filename": "sigmaepsilon.plotting.plotly-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "aa54b6f8231653eb814e20f0e8268212",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.7",
"size": 82751,
"upload_time": "2023-08-10T11:59:37",
"upload_time_iso_8601": "2023-08-10T11:59:37.045246Z",
"url": "https://files.pythonhosted.org/packages/97/79/04c5ace954dfa34cd34dea56f4e4a3d2ba04027a44ca3de43735985267ee/sigmaepsilon.plotting.plotly-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-10 11:59:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sigma-epsilon",
"github_project": "sigmaepsilon.plotting.plotly",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "sigmaepsilon.plotting.plotly"
}