Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ignition-devs/ignition-api-7.9
📦 Package for the Ignition Scripting API version 7.9
https://github.com/ignition-devs/ignition-api-7.9
ignition ignition-scripting industrial-automation industrial-iot pip-package python python2 python27 scada
Last synced: 3 days ago
JSON representation
📦 Package for the Ignition Scripting API version 7.9
- Host: GitHub
- URL: https://github.com/ignition-devs/ignition-api-7.9
- Owner: ignition-devs
- License: mit
- Archived: true
- Created: 2022-03-14T22:49:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T20:44:26.000Z (over 1 year ago)
- Last Synced: 2024-07-09T02:57:21.761Z (3 months ago)
- Topics: ignition, ignition-scripting, industrial-automation, industrial-iot, pip-package, python, python2, python27, scada
- Language: Python
- Homepage: https://docs.inductiveautomation.com/display/DOC79/Scripting+Functions
- Size: 717 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ignition-api 7.9
[](https://github.com/ignition-api/7.9/graphs/contributors)
[](https://pepy.tech/project/ignition-api)
[](https://sourcery.ai)
[](https://pre-commit.com/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://flake8.pycqa.org/en/latest/)
[](https://www.pydocstyle.org/en/stable/)
[](https://github.com/PyCQA/pylint)
[](https://github.com/ignition-api/discussions/discussions)
ignition-api is a Python package that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.
## Table of contents
- [Prerequisites](#prerequisites)
- [Installation and usage](#installation-and-usage)
- [Installing with pip](#installing-with-pip)
- [Downloading from releases](#downloading-from-releases)
- [Using as a dependency in PyCharm](#using-as-a-dependency-in-pycharm)
- [Project structure](#project-structure)
- [Packages](#packages)
- [Contributing](#contributing)
- [Discussions](#discussions)
- [Contributors](#contributors)
- [License](#license)
- [Code of conduct](#code-of-conduct)
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed Python 2.7.18 ([download here](https://www.python.org/downloads/release/python-2718/))
- You are familiar with [Ignition 7.9 Scripting Functions](https://docs.inductiveautomation.com/display/DOC79/Scripting+Functions)
## Installation and usage
To use Ignition, you may install it by doing any of the following.
### Installing with `pip`
The preferred method is to install it by running `pip`. It requires Python 2.7.18.
```bash
python2 -m pip install ignition-api==7.9.21
```
This will install it as package to your Python installation, which will allow you to call Ignition Scripting functions from Python's REPL, and get code completion using an IDE such as PyCharm and Visual Studio Code.
```bash
$ python2
Python 2.7.18 (default, Nov 9 2020, 16:23:15)
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.21)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from __future__ import print_function
>>> import system.util
>>> print(system.util.__doc__)
Utility Functions.
The following functions give you access to view various Gateway and
Client data, as well as interact with other various systems.
>>> system.util.beep()
>>> quit()
```
And to uninstall:
```bash
python2 -m pip uninstall ignition-api
```
### Downloading from releases
You may also download the code targeted to your desired version from the [releases page](https://github.com/ignition-api/7.9/releases) and add it as a dependency to your scripting project.
#### Using as a dependency in PyCharm
To include ignition-api as a dependency in PyCharm, you will need to attach it to your project.
1. Clone the repo or download from [releases](https://github.com/ignition-api/7.9/releases)
2. With your project open where you want to include `ignition-api`, navigate to `File > Open` and select the `ignition-api` project folder
3. Choose `Attach` when prompted
4. Under the `ignitition-api` project folder, right-click on the `src/` folder and choose `Mark Directory as > Sources Root`
## Project structure
### Packages
Ignition consists of the following packages:
- com.inductiveautomation
- java
- javax
- org
- system
#### com.inductiveautomation
This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here: .
#### java/javax
These packages include supporting Java classes and interfaces. For more information, see documentation here: .
#### org.apache
This package includes supporting classes and interfaces from Apache Commons Lang API. For more information, see documentation here:
#### org.python
This package includes supporting Jython classes and interfaces. For more information, see documentation here: .
#### org.slf4j
This package includes supporting classes and interfaces from SLF4J API Module. For more information, see documentation here: .
#### system
This package includes all Ignition Scripting Functions. For more information, see documentation here: .
## 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/7.9/graphs/contributors).
## License
See the [LICENSE](https://github.com/ignition-api/7.9/blob/HEAD/LICENSE).
## Code of conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).