Metadata-Version: 2.1
Name: incendium-stubs
Version: 2022.9.2.post1
Summary: incendium stubs package
Home-page: https://thecesrom.dev/incendium-stubs
Author: César Román
Author-email: cesar@thecesrom.dev
License: MIT
Project-URL: Funding, https://github.com/sponsors/thecesrom
Project-URL: Source, https://github.com/thecesrom/incendium-stubs
Project-URL: Tracker, https://github.com/thecesrom/incendium-stubs/issues
Keywords: hmi,ignition,inductive automation,scada
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
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
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Typing :: Stubs Only
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# incendium-stubs

<!--- Badges --->
![GitHub last commit (stubs)](https://img.shields.io/github/last-commit/thecesrom/incendium-stubs/main)
[![GitHub contributors](https://img.shields.io/github/contributors/thecesrom/incendium-stubs)](https://github.com/thecesrom/incendium-stubs/graphs/contributors)
[![Downloads](https://pepy.tech/badge/incendium-stubs)](https://pepy.tech/project/incendium-stubs)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/thecesrom/incendium-stubs/main.svg)](https://results.pre-commit.ci/latest/github/thecesrom/incendium-stubs/main)
[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/thecesrom/incendium/discussions)

This package contains a collection of [stubs](https://www.python.org/dev/peps/pep-484/) for [`thecesrom/incendium`](https://github.com/thecesrom/incendium). These files were generated using `mypy`'s [`stubgen`](https://mypy.readthedocs.io/en/stable/stubgen.html).

## Installation and usage

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

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

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

```sh
mypy src
```

Or

```sh
mypy code.py
```

## Contributing

See [CONTRIBUTING.md](https://github.com/thecesrom/incendium/blob/code/CONTRIBUTING.md#contributing-to-incendium).

## Discussions

Feel free to post your questions and/or ideas at [Discussions](https://github.com/thecesrom/icendium/discussions).

## Contributors

Thanks to everyone who has contributed to this project.

Up-to-date list of contributors can be found [here](https://github.com/thecesrom/incendium-stubs/graphs/contributors).

## License

See the [LICENSE](https://github.com/thecesrom/incendium-stubs/blob/HEAD/LICENSE).

## Code of conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
