ignition-api 8.3
ignition-api is a Python package that allows developers to get code completion for Ignition Scripting API functions in their IDE of choice.
Table of contents
- Prerequisites
- Installation
- Stubs
- Project structure
- Contributing
- Discussions
- Contributors
- License
- Code of conduct
- Disclaimer
Prerequisites
Before you begin, ensure you have met the following requirements:
- Python 2.7.18
- Familiarity with Ignition System Functions
Installation
Requires Python 2.7.18.
python2 -m pip install ignition-api
This installs the package to your Python 2 installation, allowing you to call Ignition Scripting functions from Python's REPL and get code completion in IDEs such as PyCharm and Visual Studio Code.
$ 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()
To uninstall:
python2 -m pip uninstall ignition-api
Stubs
ignition-api-stubs is a companion package that provides Python type stubs
(.pyi files) for the Ignition Scripting API. Type stubs enable static type
checking and enhanced IDE support for code that depends on ignition-api.
Project structure
Packages
This project consists of the following packages:
com.google
This package includes supporting classes and interfaces from Guava: Google Core Libraries for Java 32.0.1-jre API. For more information, see documentation here: https://javadoc.io/doc/com.google.guava/guava/32.0.1-jre/index.html
com.inductiveautomation
This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here: https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.9/index.html.
org.apache
org.apache.commons.lang3
This package includes supporting classes and interfaces from Apache Commons Lang 3.11 API. For more information, see documentation here: https://javadoc.io/doc/org.apache.commons/commons-lang3/3.11/index.html
org.apache.commons.math3
This package includes supporting classes and interfaces from Apache Commons Math 3.6.1 API. For more information, see documentation here: https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.html
org.apache.commons.poi
This package includes supporting classes and interfaces from Apache POI 4.1.2 API. For more information, see documentation here: https://www.javadoc.io/doc/org.apache.poi/poi/4.1.2/index.html
org.bson
This package includes supporting classes and interfaces from Mongo Java driver 4.8.1, see documentation here: https://javadoc.io/doc/org.mongodb/bson/4.8.1/index.html
org.json
This package includes supporting classes and interfaces from the Inductive
Automation's org.json package, see documentation here:
https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.9/org/json/package-summary.html
org.python
This package includes supporting Jython classes and interfaces. For more information, see documentation here: https://www.javadoc.io/doc/org.python/jython-standalone/2.7.4/index.html.
org.slf4j
This package includes supporting classes and interfaces from SLF4J API Module. For more information, see documentation here: https://www.javadoc.io/doc/org.slf4j/slf4j-api/2.0.12/index.html.
system
This package includes all Ignition Scripting Functions. For more information, see documentation here: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions.
Contributing
See CONTRIBUTING.md.
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: CONTRIBUTORS.
License
See the LICENSE.
Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct.
Disclaimer
This project is not an official product of Inductive Automation. Ignition is a trademark of Inductive Automation. This package is community-maintained and provided as-is for development assistance purposes.
1 maintainer
Metadata
1 maintainer
Release files for ignition-api 8.3.9.post1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ignition_api-8.3.9.post1.tar.gz | 184.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ignition_api-8.3.9.post1-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 437.5 kB
Release files / ignition_api-8.3.9.post1.tar.gz
| Download URL | ignition_api-8.3.9.post1.tar.gz |
|---|---|
| Size | 184.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db6fb22f9f9c5c0009bacacbcd32420039f242fc1454e8c711bd7aba4e1f5cb9
|
|
BLAKE2b-256 checksum How to use checksums |
1a99409869e8f8298abe4e550f181e5acd6d2e4bc5aa259020cffe0c4402231c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.1 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18
|
Release files / ignition_api-8.3.9.post1-py2-none-any.whl
| Download URL | ignition_api-8.3.9.post1-py2-none-any.whl |
|---|---|
| Size | 253.3 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
562b292758f680557539ecfc6d2603ff00364f680e6e5807a8e57171ee56250a
|
|
BLAKE2b-256 checksum How to use checksums |
7d9a02f615729fdfc98331cbdf620033c716bd7282fa032fed17665f9584d6c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.1 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18
|
