Skip to main content

Ignition Scripting API

Project description

ignition-api 8.1

GitHub last commit (8.1) GitHub contributors Downloads Sourcery pre-commit Code style: black Imports: isort Imports: flake8 Imports: pydocstyle linting: pylint Join us on GitHub discussions

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


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

Installation and usage

To use ignition-api, 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

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.

  1. Clone the repo or download from releases
  2. With your project open where you want to include ignition-api, navigate to File > Open and select the ignition-api project folder
  3. Choose Attach when prompted
  4. Under the ignitition-api project folder, right-click on the src/ folder and choose Mark Directory as > Sources Root

Project structure


This project consists of the following packages:

  • com.inductiveautomation
  • java
  • javax
  • org
  • system


This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here:


These packages include supporting Java classes and interfaces. For more information, see documentation here:


This package includes supporting classes and interfaces from Apache Commons Math API. For more information, see documentation here:


This package includes supporting classes and interfaces from the Inductive Automation's org.json package, see documentation here:


This package includes supporting Jython classes and interfaces. For more information, see documentation here:


This package includes supporting classes and interfaces from SLF4J API Module. For more information, see documentation here:


This package includes all Ignition Scripting Functions. For more information, see documentation here:




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.

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

ignition_api-8.1.37.post1.tar.gz (176.2 kB view hashes)

Uploaded source

Built Distribution

ignition_api-8.1.37.post1-py2-none-any.whl (242.8 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page