| Name | plotly-stubs JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Type stubs for plotly. |
| upload_time | 2025-02-18 10:16:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.10 |
| license | MIT License
Copyright (c) 2025 Claas Rostock
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 |
plotly
stubs
types
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://pypi.python.org/pypi/plotly-stubs)
[](https://pypi.python.org/pypi/plotly-stubs)
[](https://github.com/ClaasRostock/plotly-stubs/blob/main/LICENSE)
[][plotly_stubs_docs]
# plotly-stubs
plotly-stubs is a [stub-only package](https://typing.readthedocs.io/en/latest/spec/distributing.html#stub-only-packages) containing static type annotations for [plotly](https://plotly.com/python/).
## Installation
```sh
pip install plotly-stubs
```
## Documentation
See plotly-stubs's [documentation][plotly_stubs_docs].
> Note: Only very basic documentation as per now.
## Development Setup
### 1. Install uv
This project uses `uv` as package manager.
If you haven't already, install [uv](https://docs.astral.sh/uv), preferably using it's ["Standalone installer"](https://docs.astral.sh/uv/getting-started/installation/#__tabbed_1_2) method: <br>
..on Windows:
```sh
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
..on MacOS and Linux:
```sh
curl -LsSf https://astral.sh/uv/install.sh | sh
```
(see [docs.astral.sh/uv](https://docs.astral.sh/uv/getting-started/installation/) for all / alternative installation methods.)
Once installed, you can update `uv` to its latest version, anytime, by running:
```sh
uv self update
```
### 2. Install Python
This project requires Python 3.10 or later. <br>
If you don't already have a compatible version installed on your machine, the probably most comfortable way to install Python is through `uv`:
```sh
uv python install
```
This will install the latest stable version of Python into the uv Python directory, i.e. as a uv-managed version of Python.
Alternatively, and if you want a standalone version of Python on your machine, you can install Python either via `winget`:
```sh
winget install --id Python.Python
```
or you can download and install Python from the [python.org](https://www.python.org/downloads/) website.
### 3. Clone the repository
Clone the plotly-stubs repository into your local development directory:
```sh
git clone https://github.com/ClaasRostock/plotly-stubs path/to/your/dev/plotly-stubs
```
Change into the project directory after cloning:
```sh
cd plotly-stubs
```
### 4. Install dependencies
Run `uv sync` to create a virtual environment and install all project dependencies into it:
```sh
uv sync
```
> **Note**: Using `--no-dev` will omit installing development dependencies.
> **Note**: `uv` will create a new virtual environment called `.venv` in the project root directory when running
> `uv sync` the first time. Optionally, you can create your own virtual environment using e.g. `uv venv`, before running
> `uv sync`.
### 5. (Optional) Activate the virtual environment
When using `uv`, there is in almost all cases no longer a need to manually activate the virtual environment. <br>
`uv` will find the `.venv` virtual environment in the working directory or any parent directory, and activate it on the fly whenever you run a command via `uv` inside your project folder structure:
```sh
uv run <command>
```
However, you still _can_ manually activate the virtual environment if needed.
When developing in an IDE, for instance, this can in some cases be necessary depending on your IDE settings.
To manually activate the virtual environment, run one of the "known" legacy commands: <br>
..on Windows:
```sh
.venv\Scripts\activate.bat
```
..on Linux:
```sh
source .venv/bin/activate
```
### 6. Install pre-commit hooks
The `.pre-commit-config.yaml` file in the project root directory contains a configuration for pre-commit hooks.
To install the pre-commit hooks defined therein in your local git repository, run:
```sh
uv run pre-commit install
```
All pre-commit hooks configured in `.pre-commit-config.yaml` will now run each time you commit changes.
pre-commit can also manually be invoked, at anytime, using:
```sh
uv run pre-commit run --all-files
```
To skip the pre-commit validation on commits (e.g. when intentionally committing broken code), run:
```sh
uv run git commit -m <MSG> --no-verify
```
To update the hooks configured in `.pre-commit-config.yaml` to their newest versions, run:
```sh
uv run pre-commit autoupdate
```
### 7. Test that the installation works
To test that the installation works, run pytest in the project root folder:
```sh
uv run pytest
```
## Meta
Copyright (c) 2025 [Claas Rostock](https://github.com/ClaasRostock). All rights reserved.
Claas Rostock - [@LinkedIn](https://www.linkedin.com/in/claasrostock/?locale=en_US) - claas.rostock@dnv.com
Distributed under the MIT license. See [LICENSE](LICENSE.md) for more information.
[https://github.com/ClaasRostock/plotly-stubs](https://github.com/ClaasRostock/plotly-stubs)
## Contributing
1. Fork it (<https://github.com/ClaasRostock/plotly-stubs/fork>)
2. Create an issue in your GitHub repo
3. Create your branch based on the issue number and type (`git checkout -b issue-name`)
4. Evaluate and stage the changes you want to commit (`git add -i`)
5. Commit your changes (`git commit -am 'place a descriptive commit message here'`)
6. Push to the branch (`git push origin issue-name`)
7. Create a new Pull Request in GitHub
<!-- Markdown link & img dfn's -->
[plotly_stubs_docs]: https://ClaasRostock.github.io/plotly-stubs/README.html
Raw data
{
"_id": null,
"home_page": null,
"name": "plotly-stubs",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Claas Rostock <claas.rostock@dnv.com>",
"keywords": "plotly, stubs, types",
"author": null,
"author_email": "Claas Rostock <claas.rostock@dnv.com>",
"download_url": "https://files.pythonhosted.org/packages/69/a3/504b3a443c156bfb188a22eebf65f6fe74f5e44fa7a313ae518480fcbeee/plotly_stubs-0.0.3.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/plotly-stubs)\n[](https://pypi.python.org/pypi/plotly-stubs)\n[](https://github.com/ClaasRostock/plotly-stubs/blob/main/LICENSE)\n\n[][plotly_stubs_docs]\n\n# plotly-stubs\nplotly-stubs is a [stub-only package](https://typing.readthedocs.io/en/latest/spec/distributing.html#stub-only-packages) containing static type annotations for [plotly](https://plotly.com/python/).\n\n\n## Installation\n\n```sh\npip install plotly-stubs\n```\n\n## Documentation\n\nSee plotly-stubs's [documentation][plotly_stubs_docs].\n> Note: Only very basic documentation as per now.\n\n\n## Development Setup\n\n### 1. Install uv\nThis project uses `uv` as package manager.\nIf you haven't already, install [uv](https://docs.astral.sh/uv), preferably using it's [\"Standalone installer\"](https://docs.astral.sh/uv/getting-started/installation/#__tabbed_1_2) method: <br>\n..on Windows:\n```sh\npowershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n```\n..on MacOS and Linux:\n```sh\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n(see [docs.astral.sh/uv](https://docs.astral.sh/uv/getting-started/installation/) for all / alternative installation methods.)\n\nOnce installed, you can update `uv` to its latest version, anytime, by running:\n```sh\nuv self update\n```\n\n### 2. Install Python\nThis project requires Python 3.10 or later. <br>\nIf you don't already have a compatible version installed on your machine, the probably most comfortable way to install Python is through `uv`:\n```sh\nuv python install\n```\nThis will install the latest stable version of Python into the uv Python directory, i.e. as a uv-managed version of Python.\n\nAlternatively, and if you want a standalone version of Python on your machine, you can install Python either via `winget`:\n```sh\nwinget install --id Python.Python\n```\nor you can download and install Python from the [python.org](https://www.python.org/downloads/) website.\n\n### 3. Clone the repository\nClone the plotly-stubs repository into your local development directory:\n```sh\ngit clone https://github.com/ClaasRostock/plotly-stubs path/to/your/dev/plotly-stubs\n```\nChange into the project directory after cloning:\n```sh\ncd plotly-stubs\n```\n\n### 4. Install dependencies\nRun `uv sync` to create a virtual environment and install all project dependencies into it:\n```sh\nuv sync\n```\n> **Note**: Using `--no-dev` will omit installing development dependencies.\n\n> **Note**: `uv` will create a new virtual environment called `.venv` in the project root directory when running\n> `uv sync` the first time. Optionally, you can create your own virtual environment using e.g. `uv venv`, before running\n> `uv sync`.\n\n### 5. (Optional) Activate the virtual environment\nWhen using `uv`, there is in almost all cases no longer a need to manually activate the virtual environment. <br>\n`uv` will find the `.venv` virtual environment in the working directory or any parent directory, and activate it on the fly whenever you run a command via `uv` inside your project folder structure:\n```sh\nuv run <command>\n```\n\nHowever, you still _can_ manually activate the virtual environment if needed.\nWhen developing in an IDE, for instance, this can in some cases be necessary depending on your IDE settings.\nTo manually activate the virtual environment, run one of the \"known\" legacy commands: <br>\n..on Windows:\n```sh\n.venv\\Scripts\\activate.bat\n```\n..on Linux:\n```sh\nsource .venv/bin/activate\n```\n\n### 6. Install pre-commit hooks\nThe `.pre-commit-config.yaml` file in the project root directory contains a configuration for pre-commit hooks.\nTo install the pre-commit hooks defined therein in your local git repository, run:\n```sh\nuv run pre-commit install\n```\n\nAll pre-commit hooks configured in `.pre-commit-config.yaml` will now run each time you commit changes.\n\npre-commit can also manually be invoked, at anytime, using:\n```sh\nuv run pre-commit run --all-files\n```\n\nTo skip the pre-commit validation on commits (e.g. when intentionally committing broken code), run:\n```sh\nuv run git commit -m <MSG> --no-verify\n```\n\nTo update the hooks configured in `.pre-commit-config.yaml` to their newest versions, run:\n```sh\nuv run pre-commit autoupdate\n```\n\n### 7. Test that the installation works\nTo test that the installation works, run pytest in the project root folder:\n```sh\nuv run pytest\n```\n\n## Meta\n\nCopyright (c) 2025 [Claas Rostock](https://github.com/ClaasRostock). All rights reserved.\n\nClaas Rostock - [@LinkedIn](https://www.linkedin.com/in/claasrostock/?locale=en_US) - claas.rostock@dnv.com\n\nDistributed under the MIT license. See [LICENSE](LICENSE.md) for more information.\n\n[https://github.com/ClaasRostock/plotly-stubs](https://github.com/ClaasRostock/plotly-stubs)\n\n## Contributing\n\n1. Fork it (<https://github.com/ClaasRostock/plotly-stubs/fork>)\n2. Create an issue in your GitHub repo\n3. Create your branch based on the issue number and type (`git checkout -b issue-name`)\n4. Evaluate and stage the changes you want to commit (`git add -i`)\n5. Commit your changes (`git commit -am 'place a descriptive commit message here'`)\n6. Push to the branch (`git push origin issue-name`)\n7. Create a new Pull Request in GitHub\n\n<!-- Markdown link & img dfn's -->\n[plotly_stubs_docs]: https://ClaasRostock.github.io/plotly-stubs/README.html\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Claas Rostock\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Type stubs for plotly.",
"version": "0.0.3",
"project_urls": {
"Changelog": "https://github.com/ClaasRostock/plotly-stubs/blob/main/CHANGELOG.md",
"Documentation": "https://ClaasRostock.github.io/plotly-stubs/README.html",
"Homepage": "https://github.com/ClaasRostock/plotly-stubs",
"Issues": "https://github.com/ClaasRostock/plotly-stubs/issues",
"Repository": "https://github.com/ClaasRostock/plotly-stubs.git"
},
"split_keywords": [
"plotly",
" stubs",
" types"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7eefef3dd0ef58810288e5892ec19ce24b745304294e2973941b829f35e5a6f9",
"md5": "fb615930eb20327ca4ed6ca8ca4fb982",
"sha256": "5e1a2313ca0b64bff4dd1292bda79f5fc0f83c635d1775500ce954ae76e6607d"
},
"downloads": -1,
"filename": "plotly_stubs-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb615930eb20327ca4ed6ca8ca4fb982",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 89021,
"upload_time": "2025-02-18T10:16:52",
"upload_time_iso_8601": "2025-02-18T10:16:52.541613Z",
"url": "https://files.pythonhosted.org/packages/7e/ef/ef3dd0ef58810288e5892ec19ce24b745304294e2973941b829f35e5a6f9/plotly_stubs-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "69a3504b3a443c156bfb188a22eebf65f6fe74f5e44fa7a313ae518480fcbeee",
"md5": "63ec4a471bd9e1b91cc86794cd140412",
"sha256": "518b104c68817228e20a1a4dce990057732c3aefa0391ad78a5178ec12c3fbeb"
},
"downloads": -1,
"filename": "plotly_stubs-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "63ec4a471bd9e1b91cc86794cd140412",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 43968,
"upload_time": "2025-02-18T10:16:54",
"upload_time_iso_8601": "2025-02-18T10:16:54.010957Z",
"url": "https://files.pythonhosted.org/packages/69/a3/504b3a443c156bfb188a22eebf65f6fe74f5e44fa7a313ae518480fcbeee/plotly_stubs-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-18 10:16:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ClaasRostock",
"github_project": "plotly-stubs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "plotly-stubs"
}
