Package that extends and wraps Ignition Scripting API.
Reason this release was yanked:
ignition-api-jython is no longer under development
Project description
incendium
(/inˈken.di.um/)
noun
- A fire, inferno, conflagration; heat; torch.
- (heat of) passion, vehemence
Description
:package: Package that extends and wraps some functions from Ignition's Scripting API.
For more information, please refer to the Wiki.
Branches
This repository consists of the following branches:
code
This branch will contain the source code for incendium's scripting functions.
project
This branch will contain the project folder structure as stored under $IGNITION_DIR/data/projects
, and gives you the ability to get the latest code by cloning at the projects
folder.
Installing incendium as a Project on your Gateway
To install incendium on your Gateway follow these steps:
- Download incendium.x.x.x.zip from the latest release or from Ignition Exchange
- Browse to your Ignition Gateway (version 8.0+)
- Go to Config > Projects and click on Import project...
- Click on Choose File and select the downloaded ZIP file
- Enter incendium as the Project Name
- If you're replacing a previous version, make sure to check Allow Overwrite
- Click on Import
Alternatively you could follow the instructions for cloning the project
branch directly into $IGNITION_DIR/data/projects
found here.
Using incendium within your scripting projects
Prerequisites
Before you begin, ensure you have met the following requirements:
- Java 11.0.11 (here)
- Jython
- 2.7.1 for Ignition 8.0 through 8.1.7
- Download here
- Or via Homebrew
brew install coatl-dev/coatl-dev/jython@2.7.1
- 2.7.2 for Ignition 8.1.8 onwards
- Download here
- Or via Homebrew
brew install coatl-dev/coatl-dev/jython@2.7.2
- 2.7.1 for Ignition 8.0 through 8.1.7
- You are familiar with Ignition System Functions
- You have installed Ignition by Inductive Automation (optional)
Installing via pip
To use incendium as a dependency for your scripting projects using Jython 2.7.1 or 2.7.2 as your interpreter, do the following:
- Make sure you have installed
ignition-api-jython
. See here. - Then, run the following command:
$ jython -m pip install https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip DEPRECATION: A future version of pip will drop support for Python 2.7. Collecting https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip Downloading https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip - 51kB 624kB/s Installing collected packages: incendium Running setup.py install for incendium ... done Successfully installed incendium-1.0.7 $ jython -m pip list DEPRECATION: A future version of pip will drop support for Python 2.7. Package Version ------------------- ------- ignition-api-jython 8.1.10 incendium 1.0.7 pip 19.1 setuptools 41.0.1
- Now you will have both
ignition-api-jython
andincendium
installed on on your Jython site-packaages
Contributing to incendium
To contribute to incendium, follow these steps:
- Fork this repository
- Create a local copy on your machine
- Create a branch
- Make sure to run
pre-commit install
to install required pre-commit hooks - Make your changes and commit them
- Push to the
code
branch - Create the pull request
Alternatively see the GitHub documentation on creating a pull request.
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.
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 incendium-1.0.7.post1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c35d100717fc149fc750a5d3efa10975d4baad4844640b40020ffa1ecafb2181 |
|
MD5 | 09702166a4e299c8ed6fdcf076ce8a4b |
|
BLAKE2b-256 | 83313cf2cf5af1c2bd01a0054b67a7d9396996a3265dce1b21edf9a23fa9f08d |