Metadata-Version: 2.1
Name: ignition-api
Version: 8.1.14
Summary: Ignition Scripting API
Home-page: https://thecesrom.dev/Ignition
Author: César Román
Author-email: cesar@thecesrom.dev
License: MIT
Project-URL: Source, https://github.com/thecesrom/Ignition
Project-URL: Documentation, https://docs.inductiveautomation.com/display/DOC81/System+Functions
Project-URL: Funding, https://github.com/sponsors/thecesrom
Project-URL: Tracker, https://github.com/thecesrom/Ignition/issues
Description: # Ignition
        
        <!--- Badges --->
        ![GitHub last commit (main)](https://img.shields.io/github/last-commit/thecesrom/Ignition/main)
        [![GitHub contributors](https://img.shields.io/github/contributors/thecesrom/Ignition)](https://github.com/thecesrom/Ignition/graphs/contributors)
        [![GitHub downloads](https://img.shields.io/github/downloads/thecesrom/Ignition/total)](https://github.com/thecesrom/Ignition/releases)
        [![time tracker](https://wakatime.com/badge/github/thecesrom/Ignition.svg)](https://wakatime.com/badge/github/thecesrom/Ignition)
        [![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
        [![Imports: flake8](https://img.shields.io/badge/%20imports-flake8-%231674b1?style=flat&labelColor=ef8336)](https://flake8.pycqa.org/en/latest/)
        [![Imports: pydocstyle](https://img.shields.io/badge/%20imports-pydocstyle-%231674b1?style=flat&labelColor=ef8336)](https://www.pydocstyle.org/en/stable/)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/thecesrom/Ignition/main.svg)](https://results.pre-commit.ci/latest/github/thecesrom/Ignition/main)
        
        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
        
        - [Releases](#releases)
        - [Branches](#branches)
          - [Cloning a single branch](#cloning-a-single-branch)
        - [Prerequisites](#prerequisites)
        - [Packages](#packages)
        - [Installation and usage](#installation-and-usage)
          - [Installing with pip](#installing-with-pip)
          - [Downloading from releases](#downloading-from-releases)
            - [PyCharm installation](#pycharm-installation)
        - [Contributing to Ignition](#contributing-to-ignition)
        - [Discussions](#discussions)
        - [Contributors](#contributors)
        - [License](#license)
        - [Code of conduct](#code-of-conduct)
        
        ## Releases
        
        Check the [releases page](https://github.com/thecesrom/Ignition/releases) and download the one for your current version.
        
        ## Branches
        
        This repository consists of the following branches:
        
        ### [main](https://github.com/thecesrom/Ignition/tree/main)
        
        This branch will contain all Scripting Functions from the latest Ignition Release.
        
        ### [7.9](https://github.com/thecesrom/Ignition/tree/7.9)
        
        This branch will contain all Scripting Functions from the latest Ignition Release for the 7.9 version.
        
        ### [8.0](https://github.com/thecesrom/Ignition/tree/8.0)
        
        This branch will contain all Scripting Functions from the latest Ignition Release for the 8.0 version.
        
        ### jython [Archived]
        
        This branch is no longer maintained and it has been archived here: <https://github.com/thecesrom/ignition-api-jython>.
        
        ### Cloning a single branch
        
        If you wish to clone just one branch in particular, use any of the following commands:
        
        - HTTPS
        
            ```bash
            git clone --single-branch --branch <name> https://github.com/thecesrom/Ignition.git [<directory>]
            ```
        
        - SSH
        
            ```bash
            git clone --single-branch --branch <name> git@github.com:thecesrom/Ignition.git [<directory>]
            ```
        
        - GitHub CLI
        
            ```bash
            gh repo clone thecesrom/Ignition [<directory>] -- --single-branch --branch <name>
            ```
        
        #### Prerequisites
        
        Before you begin, ensure you have met the following requirements:
        
        - You have installed Python 2.7.18 ([download here](https://www.python.org/downloads/release/python-2718/))
        - You are familiar with [Ignition 8.1 System Functions](https://docs.inductiveautomation.com/display/DOC81/System+Functions)
        
        #### Packages
        
        Ignition consists of the following packages:
        
        - com.inductiveautomation
        - java
        - javax
        - org
        - system
        
        ##### com.inductiveautomation
        
        This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here: <https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.12/index.html>.
        
        ##### java/javax
        
        These packages include supporting Java classes and interfaces. For more information, see documentation here: <https://docs.oracle.com/en/java/javase/11/docs/api/index.html>.
        
        ##### org.apache
        
        This 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.html>
        
        ##### org.python
        
        This package includes supporting Jython classes and interfaces. For more information, see documentation here: <https://www.javadoc.io/doc/org.python/jython-standalone/2.7.2/index.html>.
        
        ##### system
        
        This package includes all Ignition Scripting Functions. For more information, see documentation here: <https://docs.inductiveautomation.com/display/DOC81/System+Functions>.
        
        #### Installation and usage
        
        To use Ignition, 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.
        
        ```bash
        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).
        
        ```bash
        $ 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:
        
        ```bash
        python2 -m pip uninstall ignition-api
        ```
        
        ###### Using Ignition as a dependency on PyCharm
        
        To include Ignition as a dependency on PyCharm, you will need to attach it to your project.
        
        1. Clone the repo or download from [releases](https://github.com/thecesrom/Ignition/releases)
        2. With your project open where you want to include `Ignition`, navigate to `File > Open` and select the `Ignition` project folder
        3. Choose `Attach` when prompted
        4. Under the `Ignition` project folder, right-click on the `src/` folder and choose `Mark Directory as > Sources Root`
        
        #### 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 `main` branch
        6. Create the pull request
        
        Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
        
        #### Discussions
        
        Feel free to post your questions and/or ideas at [Discussions](https://github.com/thecesrom/incendium/discussions).
        
        #### Contributors
        
        Thanks to everyone who has contributed to this project.
        
        Up-to-date list of contributors can be found [here](https://github.com/thecesrom/Ignition/graphs/contributors).
        
        #### License
        
        See the [LICENSE](https://github.com/thecesrom/Ignition/blob/HEAD/LICENSE).
        
        #### Code of conduct
        
        This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
        
Keywords: hmi,ignition,inductive automation,scada
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing :: Mocking
Requires-Python: ==2.7.18
Description-Content-Type: text/markdown
