Ignition Scripting API
Project description
ignition-api 7.9
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
- Installation and usage
- Project structure
- Contributing
- Discussions
- Contributors
- License
- Code of conduct
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed Python 2.7.18 (download here)
- You are familiar with Ignition 7.9 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.
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.
$ 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:
python2 -m pip uninstall ignition-api
Downloading from releases
You may also download the code targeted to your desired version from the releases page 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.
- Clone the repo or download from releases
- With your project open where you want to include
ignition-api
, navigate toFile > Open
and select theignition-api
project folder - Choose
Attach
when prompted - Under the
ignitition-api
project folder, right-click on thesrc/
folder and chooseMark 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: http://files.inductiveautomation.com/sdk/javadoc/ignition79/795/index.html.
java/javax
These packages include supporting Java classes and interfaces. For more information, see documentation here: https://docs.oracle.com/javase/8/docs/api/index.html.
org.apache
This package includes supporting classes and interfaces from Apache Commons Lang API. For more information, see documentation here: https://javadoc.io/doc/org.apache.commons/commons-lang3/3.3.2/index.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.5.3/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/1.7.21/overview-summary.html.
system
This package includes all Ignition Scripting Functions. For more information, see documentation here: https://docs.inductiveautomation.com/display/DOC79/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.
License
See the LICENSE.
Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct.
v7.9.21 (2022-07-27)
Feat
- java: add String to java.lang (#22)
v7.9.20 (2022-05-13)
Fix
- system: update type hint for
html
arg (#17)
v7.9.19 (2022-03-15)
Refactor
- Sourcery refactored main branch (#1)
v7.9.18.post7 (2022-01-20)
Refactor
- move
String
alias tojava.util
- define ColType as a type alias
v7.9.18.post6 (2021-11-30)
Feat
- simplify
beep
code
BREAKING CHANGE
system.util.beep()
will print "Beep!" when called regardless of platform
Fix
- mypy: add
String
type definition
v7.9.18.post5 (2021-11-29)
Feat
- add
String
type
v7.9.18.post4 (2021-11-26)
Fix
- install now requires typing
v7.9.18.post3 (2021-11-23)
Feat
- add type hints on all
system
functions - remove deprecated functions
- the triumphant return of
print_function
- improve
date.format
BREAKING CHANGE
- Python versions below 2.7.18 are no longer supported
export*
functions have been deprecated in favor ofsystem.dataset.export*
functions- Python versions below 2.7.18 are no longer supported
Fix
- ci: set
python-version
to '3.10' - ci: set
python-version
to 3.10.0
Refactor
- implement informal interfaces
v7.9.18.post2 (2021-09-21)
Feat
- make PyDataSet iterable
v7.9.18.post1 (2021-09-20)
Feat
- add
com
package topip
release - setup: allow installation on 2.5, 2.6, and 2.7
- setup: add setup.py
Refactor
- use pprint instead of print
- add
com
package - allow any import level for winsound
- add pylint
BREAKING CHANGE
- Since Ignition 7.9 relies on Jython 2.5.3, this project was adapted to conform with Python 2.5.6
v7.9.18 (2021-07-08)
Refactor
- java.util.Date
Feat
- pre-commit: update black 21.5b0 -> 21.5b1
- pre-commit: update flake8 3.9.1 -> 3.9.2
- pre-commit: update black 21.4b2 -> 21.5b0
- pre-commit: update black 21.4b1 -> 21.4b2
- pre-commit: update black 21.4b0 -> 21.4b1
- pre-commit: update black 20.8b1 -> 21.4b0
- pre-commit: bump flake8 to 3.9.1
v7.9.17 (2021-02-12)
Feat
- add flake8 to pre-commit hooks
v7.9.14 (2020-09-01)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ignition_api-7.9.21-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4306f5a9bc8b6e82c199add7a5e745f6a44fdb9a4c44765520522eaf3f9f05fc |
|
MD5 | 12e5f3d72e941e70ca480c00c57a2f96 |
|
BLAKE2b-256 | 60da3aeeedfce4ecbc6cddbc4d966f3459389b040709991a2671cf33e5cdfeca |