Metadata-Version: 2.1
Name: incendium
Version: 1.0.7.post1
Summary: Package that extends and wraps Ignition Scripting API.
Home-page: https://github.com/thecesrom/incendium
Author: César Román
Author-email: cesar@thecesrom.dev
License: MIT
Description: # incendium
        
        <!--- Badges --->
        [![GitHub contributors](https://img.shields.io/github/contributors/thecesrom/incendium)](https://github.com/thecesrom/incendium/graphs/contributors)
        ![GitHub total downloads](https://img.shields.io/github/downloads/thecesrom/incendium/total)
        ![GitHub last commit (code)](https://img.shields.io/github/last-commit/thecesrom/incendium)
        [![GitHub release (latest)](https://img.shields.io/github/v/release/thecesrom/incendium)](https://github.com/thecesrom/incendium/releases/latest)
        [![time tracker](https://wakatime.com/badge/github/thecesrom/incendium.svg)](https://wakatime.com/badge/github/thecesrom/incendium)
        [![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/incendium/code.svg)](https://results.pre-commit.ci/latest/github/thecesrom/incendium/code)
        
        (/inˈken.di.um/)
        
        _noun_
        
        1. A fire, inferno, conflagration; heat; torch.
        1. (heat of) passion, vehemence
        
        ## Description
        
        :package: Package that extends and wraps some functions from Ignition's Scripting API.
        
        For more information, please refer to the [Wiki](https://github.com/thecesrom/incendium/wiki).
        
        ## Branches
        
        This repository consists of the following branches:
        
        #### [code](https://github.com/thecesrom/incendium/tree/code)
        
        This branch will contain the source code for incendium's scripting functions.
        
        #### [project](https://github.com/thecesrom/incendium/tree/project)
        
        This branch will contain the project folder structure as stored under `$IGNITION_DIR/data/projects`, and gives you the ability to get the latest code by cloning at the `projects` folder.
        
        ## Installing incendium as a Project on your Gateway
        
        To install incendium on your Gateway follow these steps:
        
        1. Download **incendium.x.x.x.zip** from the [latest release](https://github.com/thecesrom/incendium/releases/latest) or from [Ignition Exchange](https://inductiveautomation.com/exchange/2104)
        1. Browse to your Ignition Gateway (version 8.0+)
        1. Go to **Config > Projects** and click on **Import project...**
        1. Click on **Choose File** and select the downloaded ZIP file
        1. Enter **incendium** as the **Project Name**
          * If you're replacing a previous version, make sure to check Allow Overwrite
        1. Click on **Import**
        
        Alternatively you could follow the instructions for cloning the `project` branch directly into `$IGNITION_DIR/data/projects` found [here](https://github.com/thecesrom/incendium/tree/project#cloning-this-branch).
        
        ## Using incendium within your scripting projects
        
        ### Prerequisites
        
        Before you begin, ensure you have met the following requirements:
        
        * Java 11.0.11 ([here](https://www.azul.com/downloads/?version=java-11-lts&package=jdk))
        * Jython
          * 2.7.1 for Ignition 8.0 through 8.1.7
            * Download [here](https://search.maven.org/remotecontent?filepath=org/python/jython-installer/2.7.1/jython-installer-2.7.1.jar)
            * Or via Homebrew `brew install coatl-dev/coatl-dev/jython@2.7.1`
          * 2.7.2 for [Ignition 8.1.8 onwards](https://docs.inductiveautomation.com/display/DOC81/New+in+this+Version#NewinthisVersion-Newin8.1.8)
            * Download [here](https://search.maven.org/remotecontent?filepath=org/python/jython-installer/2.7.1/jython-installer-2.7.2.jar)
            * Or via Homebrew `brew install coatl-dev/coatl-dev/jython@2.7.2`
        * You are familiar with [Ignition System Functions](https://docs.inductiveautomation.com/display/DOC81/System+Functions)
        * You have installed Ignition by Inductive Automation (optional)
        
        ### Installing via `pip`
        
        To use incendium as a dependency for your scripting projects using Jython 2.7.1 or 2.7.2 as your interpreter, do the following:
        
        1. Make sure you have installed `ignition-api-jython`. See [here](https://github.com/thecesrom/Ignition/tree/jython#installation-and-usage).
        1. Then, run the following command:
            ```bash
            $ jython -m pip install https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip
            DEPRECATION: A future version of pip will drop support for Python 2.7.
            Collecting https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip
              Downloading https://github.com/thecesrom/incendium/archive/refs/tags/v1.0.7.zip
                 - 51kB 624kB/s
            Installing collected packages: incendium
              Running setup.py install for incendium ... done
            Successfully installed incendium-1.0.7
            $ jython -m pip list
            DEPRECATION: A future version of pip will drop support for Python 2.7.
            Package             Version
            ------------------- -------
            ignition-api-jython 8.1.10 
            incendium           1.0.7  
            pip                 19.1   
            setuptools          41.0.1 
            ```
        1. Now you will have both `ignition-api-jython` and `incendium` installed on on your Jython site-packaages
        
        ## Contributing to incendium
        
        To contribute to incendium, follow these steps:
        
        1. Fork this repository
        2. Create a local copy on your machine
        3. Create a branch
        4. Make sure to run `pre-commit install` to install required pre-commit hooks
        5. Make your changes and commit them
        6. Push to the `code` branch
        7. 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/incendium/graphs/contributors).
        
        ## License
        
        See the [LICENSE](https://github.com/thecesrom/incendium/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 :: Only
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing :: Mocking
Requires-Python: >=2.7, <3
Description-Content-Type: text/markdown
