# ignition-api-stubs
<!--- Badges --->
[](https://pypi.org/project/ignition-api-stubs/)
[](https://pepy.tech/project/ignition-api-stubs)
[](https://results.pre-commit.ci/latest/github/ignition-devs/ignition-api-8.1-stubs/main)
[](https://github.com/orgs/ignition-devs/discussions)
This package contains a collection of [stubs] for [`ignition-api-8.1`]. These
files were generated using `mypy`'s [`stubgen`].
## Installation and usage
To use ignition-api-stubs, you may install it with `pip`. It requires Python
3.7+ through 3.12.
> [!WARNING]
> Python 3.13 will not be supported.
```sh
python3 -m pip install ignition-api-stubs
```
To run `mypy` against your code, execute the following command passing the
source directory (typically `src`) or a single file:
```sh
mypy --py2 src
```
Or
```sh
mypy --py2 code.py
```
## Contributing
See [contributing guidelines].
## Discussions
Feel free to post your questions and/or ideas at [Discussions].
## Contributors
Thanks to everyone who has contributed to this project.
Up-to-date list of contributors can be found [here].
## License
See the [LICENSE].
## Code of conduct
See [code of conduct].
<!-- Links -->
[code of conduct]: https://github.com/ignition-devs/.github/blob/main/CODE_OF_CONDUCT.md
[contributing guidelines]: https://github.com/ignition-devs/ignition-api-8.1/blob/main/CONTRIBUTING.md
[Discussions]: https://github.com/ignition-devs/discussions/discussions
[here]: https://github.com/ignition-devs/ignition-api-8.1-stubs/graphs/contributors
[`ignition-api-8.1`]: https://github.com/ignition-devs/ignition-api-8.1
[LICENSE]: ./LICENSE
[`stubgen`]: https://mypy.readthedocs.io/en/stable/stubgen.html
[stubs]: https://www.python.org/dev/peps/pep-484/
Raw data
{
"_id": null,
"home_page": null,
"name": "ignition-api-stubs",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "hmi, ignition, inductive automation, scada",
"author": null,
"author_email": "C\u00e9sar Rom\u00e1n <cesar@coatl.dev>",
"download_url": "https://files.pythonhosted.org/packages/ec/9f/a5c4f637e72b4be1fab49301036f18ac6df26f43ee062eca6b86819fd991/ignition_api_stubs-8.1.48.post2.tar.gz",
"platform": null,
"description": "# ignition-api-stubs\n\n<!--- Badges --->\n[](https://pypi.org/project/ignition-api-stubs/)\n[](https://pepy.tech/project/ignition-api-stubs)\n[](https://results.pre-commit.ci/latest/github/ignition-devs/ignition-api-8.1-stubs/main)\n[](https://github.com/orgs/ignition-devs/discussions)\n\nThis package contains a collection of [stubs] for [`ignition-api-8.1`]. These\nfiles were generated using `mypy`'s [`stubgen`].\n\n## Installation and usage\n\nTo use ignition-api-stubs, you may install it with `pip`. It requires Python\n3.7+ through 3.12.\n\n> [!WARNING]\n> Python 3.13 will not be supported.\n\n```sh\npython3 -m pip install ignition-api-stubs\n```\n\nTo run `mypy` against your code, execute the following command passing the\nsource directory (typically `src`) or a single file:\n\n```sh\nmypy --py2 src\n```\n\nOr\n\n```sh\nmypy --py2 code.py\n```\n\n## Contributing\n\nSee [contributing guidelines].\n\n## Discussions\n\nFeel free to post your questions and/or ideas at [Discussions].\n\n## Contributors\n\nThanks to everyone who has contributed to this project.\n\nUp-to-date list of contributors can be found [here].\n\n## License\n\nSee the [LICENSE].\n\n## Code of conduct\n\nSee [code of conduct].\n\n<!-- Links -->\n[code of conduct]: https://github.com/ignition-devs/.github/blob/main/CODE_OF_CONDUCT.md\n[contributing guidelines]: https://github.com/ignition-devs/ignition-api-8.1/blob/main/CONTRIBUTING.md\n[Discussions]: https://github.com/ignition-devs/discussions/discussions\n[here]: https://github.com/ignition-devs/ignition-api-8.1-stubs/graphs/contributors\n[`ignition-api-8.1`]: https://github.com/ignition-devs/ignition-api-8.1\n[LICENSE]: ./LICENSE\n[`stubgen`]: https://mypy.readthedocs.io/en/stable/stubgen.html\n[stubs]: https://www.python.org/dev/peps/pep-484/\n",
"bugtrack_url": null,
"license": null,
"summary": "Ignition Scripting API Stubs",
"version": "8.1.48.post2",
"project_urls": {
"Funding": "https://github.com/sponsors/cesarcoatl",
"Homepage": "https://ignition-devs.github.io/ignition-api-8.1-stubs/",
"Source": "https://github.com/ignition-devs/ignition-api-8.1-stubs",
"Tracker": "https://github.com/ignition-devs/ignition-api-8.1-stubs/issues"
},
"split_keywords": [
"hmi",
" ignition",
" inductive automation",
" scada"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5b669b8fcd2b9e157ee5f6da45af5247847a715512db035db5b703210ae968c5",
"md5": "94d8b51970c171d54039f8df1b4c7ca2",
"sha256": "0d2e882e8308dedf5853cc113d33ebbf438bd0a3aea799c4990859ee88941278"
},
"downloads": -1,
"filename": "ignition_api_stubs-8.1.48.post2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94d8b51970c171d54039f8df1b4c7ca2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 160146,
"upload_time": "2025-06-09T20:18:35",
"upload_time_iso_8601": "2025-06-09T20:18:35.685162Z",
"url": "https://files.pythonhosted.org/packages/5b/66/9b8fcd2b9e157ee5f6da45af5247847a715512db035db5b703210ae968c5/ignition_api_stubs-8.1.48.post2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ec9fa5c4f637e72b4be1fab49301036f18ac6df26f43ee062eca6b86819fd991",
"md5": "b3da422660f30c49767ba7406be597d9",
"sha256": "13e4ae15ec185e63a94e1e78db9241d4fd659ff8bef7d26af1482e1121af2fd4"
},
"downloads": -1,
"filename": "ignition_api_stubs-8.1.48.post2.tar.gz",
"has_sig": false,
"md5_digest": "b3da422660f30c49767ba7406be597d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 105605,
"upload_time": "2025-06-09T20:18:37",
"upload_time_iso_8601": "2025-06-09T20:18:37.339676Z",
"url": "https://files.pythonhosted.org/packages/ec/9f/a5c4f637e72b4be1fab49301036f18ac6df26f43ee062eca6b86819fd991/ignition_api_stubs-8.1.48.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-06-09 20:18:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "cesarcoatl",
"github_not_found": true,
"lcname": "ignition-api-stubs"
}
JSON
