Metadata-Version: 2.4
Name: incendium-stubs
Version: 2026.6.1
Summary: Package that extends and wraps the Ignition Scripting API
Author-email: César Román <cesar@coatl.dev>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ignition-devs/incendium
Project-URL: Source, https://github.com/ignition-devs/incendium
Project-URL: Tracker, https://github.com/ignition-devs/incendium/issues
Keywords: incendium
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Manufacturing
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Stubs Only
Classifier: Typing :: Typed
Requires-Python: <3.13,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ignition-api-stubs
Dynamic: license-file

# incendium-stubs

<!--- Badges --->
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/incendium-stubs)](https://pypi.org/project/incendium-stubs/)
[![PyPI - Version](https://img.shields.io/pypi/v/incendium-stubs)](https://pypi.org/project/incendium-stubs/)
[![PyPI - Downloads](https://pepy.tech/badge/incendium-stubs)](https://pepy.tech/project/incendium-stubs)

Package that extends and wraps the Ignition Scripting API

This package contains a collection of [stubs] generated using `mypy`'s
[`stubgen`] tool.

## Installation and usage

To use incendium-stubs, you may install it with `pip`. It requires Python
3.9 - 3.12.

```sh
python -m pip install incendium-stubs
```

To run `mypy` against your code, execute the following command passing the
source directory (typically `src`) or a single file:

```sh
mypy src
```

Or

```sh
mypy code.py
```

<!-- Links -->
[`stubgen`]: https://coatl-mypy.readthedocs.io/en/v0.971/stubgen.html
[stubs]: https://www.python.org/dev/peps/pep-484/
