https://github.com/ignition-devs/incendium
📦 Package that extends and wraps Ignition scripting API
https://github.com/ignition-devs/incendium
ignition inductive-automation java jython python python2 scada
Last synced: 7 months ago
JSON representation
📦 Package that extends and wraps Ignition scripting API
- Host: GitHub
- URL: https://github.com/ignition-devs/incendium
- Owner: ignition-devs
- License: mit
- Created: 2020-09-23T06:51:05.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T20:10:54.000Z (8 months ago)
- Last Synced: 2024-11-14T21:20:29.960Z (7 months ago)
- Topics: ignition, inductive-automation, java, jython, python, python2, scada
- Language: Python
- Homepage: https://pypi.org/project/incendium/
- Size: 495 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# incendium
[](https://github.com/ignition-devs/incendium/actions/workflows/ci.yml)
[](https://pepy.tech/project/incendium)
[](https://github.com/ignition-devs/incendium/discussions)
Package that extends and wraps some functions from Ignition's Scripting API.
For more information, please refer to the [Wiki].
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You are familiar with [Ignition 8.1 System Functions]
- You have installed [Python 2.7.18]
- You have installed [Java 17] and [Jython 2.7.3]
## Installation and usage
### Installing as a dependency for your scripting projects
To use `incendium`, you may install it with `pip`. It requires
[Python 2.7.18] or [Jython 2.7.3].
```sh
python2 -m pip install incendium
```
Or
```sh
jython -m pip install incendium
```
This will install it as package to your Python installation, which will allow
you to call `incendium`'s Scripting functions from Python's REPL, and get code
completion using an IDE (PyCharm or Visual Studio Code).
And to uninstall:
```sh
python2 -m pip uninstall incendium
```
Or
```sh
jython -m pip uninstall incendium
```
### Using as a dependency in PyCharm
To include `incendium` 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 `incendium`, navigate to
`File > Open` and select the `incendium` project folder
3. Choose `Attach` when prompted
4. Under the `incendium` project folder, right-click on the `src/` folder and
choose `Mark Directory as > Sources Root`
### Installing `incendium` on your Gateway
> [!TIP]
> You may use the [Python in Ignition] guide as reference.
#### As a Jython package
To install `incendium` as a Jython package on your Gateway, follow
these steps:
1. Install [Java 17]
2. Install [Jython 2.7.3]
3. Run `jython -m pip install incendium`
4. Copy the `incendium` directory and `typing.py` from
`$JYTHON_HOME/Lib/site-packages` to
`$IGNITION_DIR/user-lib/pylib/site-packages`
5. Done
#### As a Python package
To install `incendium` as a Python package on your Gateway, follow these steps:
1. Install [Python 2.7.18]
2. Run `python -m pip install incendium`
3. Copy the `incendium` directory and `typing.py` from
`$PYTHON2_HOME/Lib/site-packages` to
`$IGNITION_DIR/user-lib/pylib/site-packages`
4. Done
## Contributing to `incendium`
See [CONTRIBUTING.md].
## Discussions
Feel free to post your questions and/or ideas at [Discussions].
## Contributors
Thanks to everyone who has contributed to this project.
Up-to-date list of [contributors].
## License
See [LICENSE].
## Code of conduct
See [CODE_OF_CONDUCT.md].
[CODE_OF_CONDUCT.md]: https://github.com/ignition-devs/.github/blob/main/CODE_OF_CONDUCT.md
[CONTRIBUTING.md]: ./CONTRIBUTING.md#contributing-to-incendium
[contributors]: https://github.com/ignition-devs/incendium/graphs/contributors
[Discussions]: https://github.com/ignition-devs/incendium/discussions
[Ignition 8.1 System Functions]: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions
[Java 17]: https://www.azul.com/downloads/?version=java-17-lts&package=jre#zulu
[Jython 2.7.3]: https://repo1.maven.org/maven2/org/python/jython-installer/2.7.3/jython-installer-2.7.3.jar
[LICENSE]: ./LICENSE
[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/
[Python in Ignition]: https://support.inductiveautomation.com/hc/en-us/articles/360056397252-Python-In-Ignition
[releases]: https://github.com/ignition-devs/incendium/releases
[Wiki]: https://github.com/ignition-devs/incendium/wiki