Package: ignition-api
ignition-api 8.1ignition-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 contentsPrerequisitesInstallation and usageInstalling with pipDownloading from releasesUsing as a dependency in PyCharmProject structurePackagesContributingDiscussionsContributorsLicenseCode of conductPrerequisitesBefore you begin, ensure you have met the following requirements:You have installed Python 2.7.18 (download here)You are familiar withIgnition 8.1 System FunctionsInstallation and usageTo use ignition-api, you may install it by doing any of the following.Installing withpipThe preferred method is to install it by runningpip. It requires Python 2.7.18.python2-mpipinstallignition-apiThis 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
Python2.7.18(default,Nov92020,16:23:15)[GCCAppleLLVM12.0.0(clang-1200.0.32.21)]ondarwin
Type"help","copyright","credits"or"license"formoreinformation.
>>>from__future__importprint_function
>>>importsystem.util
>>>print(system.util.__doc__)UtilityFunctions.

ThefollowingfunctionsgiveyouaccesstoviewvariousGatewayand
Clientdata,aswellasinteractwithothervarioussystems.

>>>system.util.beep()>>>quit()And to uninstall:python2-mpipuninstallignition-apiDownloading from releasesYou may also download the code targeted to your desired version from thereleases pageand add it as a dependency to your scripting project.Using as a dependency in PyCharmTo include ignition-api as a dependency in PyCharm, you will need to attach it to your project.Clone the repo or download fromreleasesWith your project open where you want to includeignition-api, navigate toFile > Openand select theignition-apiproject folderChooseAttachwhen promptedUnder theignitition-apiproject folder, right-click on thesrc/folder and chooseMark Directory as > Sources RootProject structurePackagesThis project consists of the following packages:com.inductiveautomationjavajavaxorgsystemcom.inductiveautomationThis package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here:https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.37/index.html.java/javaxThese packages include supporting Java classes and interfaces. For more information, see documentation here:https://docs.oracle.com/en/java/javase/17/docs/api/index.html.org.apacheThis package includes supporting classes and interfaces from Apache Commons Math API. For more information, see documentation here:https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.htmlorg.jsonThis package includes supporting classes and interfaces from the Inductive Automation'sorg.jsonpackage, see documentation here:https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.37/org/json/package-summary.htmlorg.pythonThis package includes supporting Jython classes and interfaces. For more information, see documentation here:https://www.javadoc.io/doc/org.python/jython-standalone/2.7.3/index.html.org.slf4jThis package includes supporting classes and interfaces from SLF4J API Module. For more information, see documentation here:https://www.javadoc.io/doc/org.slf4j/slf4j-api/1.7.26/overview-summary.html.systemThis package includes all Ignition Scripting Functions. For more information, see documentation here:https://docs.inductiveautomation.com/display/DOC81/System+Functions.ContributingSeeCONTRIBUTING.md.DiscussionsFeel free to post your questions and/or ideas atDiscussions.ContributorsThanks to everyone who has contributed to this project.Up-to-date list of contributors can be foundhere.LicenseSee theLICENSE.Code of conductThis project has adopted theMicrosoft Open Source Code of Conduct.