Ignition is a set of packages and modules that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.
Table of contents
- Installation and usage
- Contributing to Ignition
- Code of conduct
Check the releases page and download the one for your current version.
If you can’t find it, feel free to submit your request on our Discussions.
This repository consists of the following branches:
This branch will contain all Scripting Functions from the latest Ignition Release requiring only Python
This branch will contain all Scripting Functions from the latest Ignition Release for the 7.9 version requiring only Python
This branch will contain all Scripting Functions from the latest Ignition Release for the 8.0 version requiring only Python
This branch will contain all Scripting Functions from the latest Ignition Release requiring Jython (see jython prerequisites)
Cloning a single branch
If you wish to clone just one branch in particular, use any of the following commands:
git clone --single-branch --branch <name> https://github.com/thecesrom/Ignition.git [<directory>]
git clone --single-branch --branch <name> firstname.lastname@example.org:thecesrom/Ignition.git [<directory>]
- GitHub CLI
gh repo clone thecesrom/Ignition [<directory>] -- --single-branch --branch <name>
Before you begin, ensure you have met the following requirements:
- You have installed Python 2.7.18 (download here)
- You are familiar with Ignition 8.1 System Functions
Ignition consists of the following packages:
These are libraries for some Java packages and functions that are imported in
system packages meant to be used on development environments where no JDK can be installed, and the project interpreter is Python 2.7.
Is a package that includes all Ignition Scripting Functions.
Installation and usage
To use Ignition, download the code targeted to your desired version from the releases page and add it as a dependency to your scripting project.
To use Ignition in PyCharm, you will need to attach it to your project.
- With your project open that you want to use with Ignition, navigate to
File > Openand select the
Attachwhen you’re prompted on how to open the project.
- Under the new
Ignitionproject folder, right-click on the
src/folder and choose
Mark Directory as > Sources Root.
Also, it can be installed by running
pip. It requires Python 2.7 (we recommend version 2.7.18).
$ python2 -m pip install ignition-api
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 (we recommend PyCharm).
Python 2.7.18 (default, Nov 9 2020, 16:23:15) [GCC Apple LLVM 12.0.0 (clang-122.214.171.124)] 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
Contributing to Ignition
To contribute to Ignition, follow these steps:
- Fork this repository
- Create a local copy on your machine
- Create a branch
- Make your changes and commit them
- Push to the
- Create the pull request
Alternatively see the GitHub documentation on creating a pull request.
Feel free to post your questions and/or ideas at Discussions.
Thanks to everyone who has contributed to this project.
Up-to-date list of contributors can be found here.
See the LICENSE.
Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct.