Metadata-Version: 2.1
Name: ignition-api-stubs
Version: 8.1.18a4
Summary: Ignition Scripting API Stubs
Home-page: https://ignition-api.github.io/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/ignition-api/stubs
Project-URL: Tracker, https://github.com/ignition-api/stubs/issues
Keywords: hmi,ignition,inductive automation,scada
Classifier: Development Status :: 3 - Alpha
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

# ignition-api-stubs

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

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

Please note that this work is currently in its Alpha stage, so don't hesitate to report any issues.

## Installation and usage

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

```sh
python -m pip install ignition-api-stubs
```

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

```sh
mypy --py2 src
```

Or

```sh
mypy --py2 code.py
```

## Contributing

See [CONTRIBUTING.md](https://github.com/ignition-api/.github/blob/main/CONTRIBUTING.md#contributing-to-ignition-api).

## Discussions

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

## Contributors

Thanks to everyone who has contributed to this project.

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

## License

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

## Code of conduct

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

# Changelog

All notable changes to this project will be documented in this file.

## [8.1.18a4] - 2022-07-09

### CI

- use settings from pyproject.toml for mypy (#8)

### Documentation

- add pre-commit.ci badge to README (#11)

### Miscellaneous Tasks

- update stubs from latest ignition-api (#9)

### Build

- add pre-commit configuration file (#7)

## [8.1.18a3] - 2022-07-05

### Bug Fixes

- remove Python 3.11 ([65dd394](https://github.com/ignition-api/stubs/commit/65dd39449b738e36c7ed592889b3adeecbfae4eb))

### CI

- add ci workflow (#3)
- use Python 3.6 and above for mypy analysis ([3c0c420](https://github.com/ignition-api/stubs/commit/3c0c420c580c981915a6eb34dfed17357002463c))

### Documentation

- add usage instructions to README (#4)

### Build

- update required packages (#5)

## [8.1.18a2] - 2022-06-29

### Miscellaneous Tasks

- add types-enum34 to install_requires ([98f3b3f](https://github.com/ignition-api/stubs/commit/98f3b3f61ebebaf5e4f937565d3febb30bea3494))

## [8.1.18a1] - 2022-06-29

### Bug Fixes

- mypy warnings ([6f10fe0](https://github.com/ignition-api/stubs/commit/6f10fe0733cca0c7015edfd45d11c16f1903578f))
- mypy warnings (#1)

### CI

- update twine token ([ebe973c](https://github.com/ignition-api/stubs/commit/ebe973c20ff1a7f9fd939db48d8b3d49033fc828))

## [8.1.18a0] - 2022-06-29

### Miscellaneous Tasks

- initial commit ([979e704](https://github.com/ignition-api/stubs/commit/979e704073701e2e1d227737b8fc493956677e69))

<!-- generated by git-cliff -->
