incendium
Package that extends and wraps the Ignition Scripting API.
For more information, please refer to the Wiki.
Prerequisites
Before you begin, ensure you have met the following requirements:
- You are familiar with Ignition 8.3 System Functions
- You have installed Python 2.7.18
- You have installed Java 17 and Jython 2.7.4
Installation and usage
Installing incendium on your Gateway
As a Jython package
To install incendium as a Jython package on your Gateway, follow
these steps:
- Install Java 17
- Install Jython 2.7.4
- Run
jython -m pip install incendium - Copy the
incendiumdirectory andtyping.pyfrom$JYTHON_HOME/Lib/site-packagesto$IGNITION_DIR/user-lib/pylib/site-packages - Done
As a Python package
To install incendium as a Python package on your Gateway, follow these steps:
- Install Python 2.7.18
- Run
python -m pip install incendium - Copy the
incendiumdirectory andtyping.pyfrom$PYTHON2_HOME/Lib/site-packagesto$IGNITION_DIR/user-lib/pylib/site-packages - Done
Installing as a dependency for your scripting projects
To use incendium, you may install it with pip. It requires
Python 2.7.18 or Jython 2.7.4.
python2 -m pip install incendium
Or
jython -m pip install incendium
This will install it as a package in your Python installation, which will allow
you to call incendium's Scripting functions from Python's REPL, and get code
completion using an IDE (PyCharm or Visual Studio Code).
And to uninstall:
python2 -m pip uninstall incendium
Or
jython -m pip uninstall incendium
Using as a dependency in PyCharm
To include incendium 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
incendium, navigate toFile > Openand select theincendiumproject folder - Choose
Attachwhen prompted - Under the
incendiumproject folder, right-click on thesrc/folder and chooseMark Directory as > Sources Root
Contributing to incendium
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.
License
See LICENSE.
Code of conduct
See CODE_OF_CONDUCT.md.
1 maintainer
Metadata
1 maintainer
Release files for incendium 2026.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| incendium-2026.9.0.tar.gz | 22.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| incendium-2026.9.0-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 51.5 kB
Release files / incendium-2026.9.0.tar.gz
| Download URL | incendium-2026.9.0.tar.gz |
|---|---|
| Size | 22.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
85e8cac0e374df6d3f1236e9130e955b5f134d1e1df2fe22ff28ddd9c07ef9ee
|
|
BLAKE2b-256 checksum How to use checksums |
43fbc1d315dbfe8b940cb2e14148e8bd5964a9f927725fa762b81ae8357930ff
|
| 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 / incendium-2026.9.0-py2-none-any.whl
| Download URL | incendium-2026.9.0-py2-none-any.whl |
|---|---|
| Size | 28.6 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
9246680a7140161a0bdc2f39afdc52af37999da35a37c397ded147dffbc54a7d
|
|
BLAKE2b-256 checksum How to use checksums |
a83277487a7fd31aec167c1347767055f500ea0cbed5191e2c741657c7de2c1a
|
| 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
|
