View on GitHub

Ignition

⚡ A set of packages and modules that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.

Ignition

GitHub last commit (main) GitHub contributors GitHub license GitHub downloads time tracker Sourcery Code style: black Imports: isort Imports: flake8 Join us on GitHub discussions

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.

Releases

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.

Branches

This repository consists of the following branches:

main

This branch will contain all Scripting Functions from the latest Ignition Release requiring only Python

7.9

This branch will contain all Scripting Functions from the latest Ignition Release for the 7.9 version requiring only Python

8.0

This branch will contain all Scripting Functions from the latest Ignition Release for the 8.0 version requiring only Python

jython

This branch will contain all Scripting Functions from the latest Ignition Release requiring Jython (see jython prerequisites)

Prerequisites

Before you begin, ensure you have met the following requirements:

Using Ignition

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.

Packages

Ignition consists of the following packages:

java/javax

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.

system

Is a package that includes all Ignition Scripting Functions.

Contributing to Ignition

To contribute to Ignition, follow these steps:

  1. Fork this repository
  2. Create a local copy on your machine
  3. Create a branch
  4. Make your changes and commit them
  5. Push to the original branch
  6. Create the pull request

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the 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.