# incendium
<!--- Badges --->
[](https://github.com/ignition-incendium/incendium/actions/workflows/ci.yml)
[](https://github.com/psf/black)
[](https://pepy.tech/project/incendium)
[](https://github.com/ignition-incendium/incendium/discussions)
:package: 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]
## Installation and usage
### Installing as a dependency for your scripting projects
To use `incendium` in your scripting projects, you may install it by doing any
of the following.
> [!TIP]
> To install `incendium` as a Jython package for your Gateway, follow
> [these instructions]
The preferred method is to install it by running `pip` on a virtual environment
using [Python 2.7.18].
```bash
python2 -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).
```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 incendium.vision.gui
>>> print(incendium.vision.gui.__doc__)
GUI module.
>>> incendium.vision.gui.warning("This one is a warning")
This one is a warning es_MX False
Warning es_MX False
None This one is a warning Warning 2 None
```
And to uninstall:
```bash
python2 -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
#### As a Jython package
Starting with version 2024.4.0, this package can be installed using Jython. You
may use the [Python in Ignition] guide as reference. But here are the basic
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
```sh
$ jython
Jython 2.7.3 (tags/v2.7.3:5f29801fe, Sep 10 2022, 18:52:49)
[OpenJDK 64-Bit Server VM (Azul Systems, Inc.)] on java17.0.11
Type "help", "copyright", "credits" or "license" for more information.
>>> from __future__ import print_function
>>> import incendium
>>> print(incendium.__doc__)
incendium.
incendium is a package that extends and wraps some functions from
Ignition Scripting API.
For more information, please refer to the Wiki.
https://github.com/ignition-incendium/incendium/wiki
```
#### As a Python package
To install `incendium` as a Python package on your Gateway, simply 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].
<!-- Links -->
[CODE_OF_CONDUCT.md]: https://github.com/ignition-incendium/.github/blob/main/CODE_OF_CONDUCT.md
[CONTRIBUTING.md]: https://github.com/ignition-incendium/.github/blob/main/CONTRIBUTING.md#contributing-to-incendium
[contributors]: https://github.com/ignition-incendium/incendium/graphs/contributors
[Discussions]: https://github.com/ignition-incendium/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-incendium/incendium/releases
[these instructions]: #as-a-jython-package
[Wiki]: https://github.com/ignition-incendium/incendium/wiki
Raw data
{
"_id": null,
"home_page": "https://github.com/ignition-incendium/incendium",
"name": "incendium",
"maintainer": null,
"docs_url": null,
"requires_python": "<3,>=2.7",
"maintainer_email": null,
"keywords": "coatl-dev, hmi, ignition, inductive automation, scada",
"author": "C\u00e9sar Rom\u00e1n",
"author_email": "cesar@coatl.dev",
"download_url": "https://files.pythonhosted.org/packages/76/1d/59432ff2c2902b8a1924c6ce9ba9026c6bbeb5f760bbfef344f6ecea0df1/incendium-2024.5.0.tar.gz",
"platform": null,
"description": "# incendium\n\n<!--- Badges --->\n[](https://github.com/ignition-incendium/incendium/actions/workflows/ci.yml)\n[](https://github.com/psf/black)\n[](https://pepy.tech/project/incendium)\n[](https://github.com/ignition-incendium/incendium/discussions)\n\n:package: Package that extends and wraps some functions from Ignition's\nScripting API.\n\nFor more information, please refer to the [Wiki].\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- You are familiar with [Ignition 8.1 System Functions]\n\n## Installation and usage\n\n### Installing as a dependency for your scripting projects\n\nTo use `incendium` in your scripting projects, you may install it by doing any\nof the following.\n\n> [!TIP]\n> To install `incendium` as a Jython package for your Gateway, follow\n> [these instructions]\n\nThe preferred method is to install it by running `pip` on a virtual environment\nusing [Python 2.7.18].\n\n```bash\npython2 -m pip install incendium\n```\n\nThis will install it as package to your Python installation, which will allow\nyou to call `incendium`'s Scripting functions from Python's REPL, and get code\ncompletion using an IDE (PyCharm or Visual Studio Code).\n\n```bash\n$ python2\nPython 2.7.18 (default, Nov 9 2020, 16:23:15)\n[GCC Apple LLVM 12.0.0 (clang-1200.0.32.21)] on darwin\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> from __future__ import print_function\n>>> import incendium.vision.gui\n>>> print(incendium.vision.gui.__doc__)\nGUI module.\n>>> incendium.vision.gui.warning(\"This one is a warning\")\nThis one is a warning es_MX False\nWarning es_MX False\nNone This one is a warning Warning 2 None\n```\n\nAnd to uninstall:\n\n```bash\npython2 -m pip uninstall incendium\n```\n\n### Using as a dependency in PyCharm\n\nTo include `incendium` as a dependency in PyCharm, you will need to attach it to\nyour project.\n\n1. Clone the repo or download from [releases]\n2. With your project open where you want to include `incendium`, navigate to\n `File > Open` and select the `incendium` project folder\n3. Choose `Attach` when prompted\n4. Under the `incendium` project folder, right-click on the `src/` folder and\n choose `Mark Directory as > Sources Root`\n\n### Installing `incendium` on your Gateway\n\n#### As a Jython package\n\nStarting with version 2024.4.0, this package can be installed using Jython. You\nmay use the [Python in Ignition] guide as reference. But here are the basic\nsteps:\n\n1. Install [Java 17]\n2. Install [Jython 2.7.3]\n3. Run `jython -m pip install incendium`\n4. Copy the `incendium` directory and `typing.py` from\n `$JYTHON_HOME/Lib/site-packages` to\n `$IGNITION_DIR/user-lib/pylib/site-packages`\n5. Done\n\n```sh\n$ jython\nJython 2.7.3 (tags/v2.7.3:5f29801fe, Sep 10 2022, 18:52:49)\n[OpenJDK 64-Bit Server VM (Azul Systems, Inc.)] on java17.0.11\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> from __future__ import print_function\n>>> import incendium\n>>> print(incendium.__doc__)\nincendium.\n\nincendium is a package that extends and wraps some functions from\nIgnition Scripting API.\n\nFor more information, please refer to the Wiki.\nhttps://github.com/ignition-incendium/incendium/wiki\n```\n\n#### As a Python package\n\nTo install `incendium` as a Python package on your Gateway, simply follow these\nsteps:\n\n1. Install [Python 2.7.18]\n2. Run `python -m pip install incendium`\n3. Copy the `incendium` directory and `typing.py` from\n `$PYTHON2_HOME/Lib/site-packages` to\n `$IGNITION_DIR/user-lib/pylib/site-packages`\n4. Done\n\n## Contributing to `incendium`\n\nSee [CONTRIBUTING.md].\n\n## Discussions\n\nFeel free to post your questions and/or ideas at [Discussions].\n\n## Contributors\n\nThanks to everyone who has contributed to this project.\n\nUp-to-date list of [contributors].\n\n## License\n\nSee [LICENSE].\n\n## Code of conduct\n\nSee [CODE_OF_CONDUCT.md].\n\n<!-- Links -->\n[CODE_OF_CONDUCT.md]: https://github.com/ignition-incendium/.github/blob/main/CODE_OF_CONDUCT.md\n[CONTRIBUTING.md]: https://github.com/ignition-incendium/.github/blob/main/CONTRIBUTING.md#contributing-to-incendium\n[contributors]: https://github.com/ignition-incendium/incendium/graphs/contributors\n[Discussions]: https://github.com/ignition-incendium/incendium/discussions\n[Ignition 8.1 System Functions]: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions\n[Java 17]: https://www.azul.com/downloads/?version=java-17-lts&package=jre#zulu\n[Jython 2.7.3]: https://repo1.maven.org/maven2/org/python/jython-installer/2.7.3/jython-installer-2.7.3.jar\n[LICENSE]: ./LICENSE\n[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/\n[Python in Ignition]: https://support.inductiveautomation.com/hc/en-us/articles/360056397252-Python-In-Ignition\n[releases]: https://github.com/ignition-incendium/incendium/releases\n[these instructions]: #as-a-jython-package\n[Wiki]: https://github.com/ignition-incendium/incendium/wiki\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package that extends and wraps Ignition Scripting API",
"version": "2024.5.0",
"project_urls": {
"Documentation": "https://github.com/ignition-incendium/incendium/wiki",
"Funding": "https://github.com/sponsors/cesarcoatl",
"Homepage": "https://github.com/ignition-incendium/incendium",
"Source": "https://github.com/ignition-incendium/incendium",
"Tracker": "https://github.com/ignition-incendium/incendium/issues"
},
"split_keywords": [
"coatl-dev",
" hmi",
" ignition",
" inductive automation",
" scada"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5dc4765f1f7cbfc163c305e428007a03a7ccfc03bba9ca02bdb7a4aca23f6be",
"md5": "542b52991598ef0ef802b684558c44b7",
"sha256": "9a9aa1c7f9a2b6e1bc75f98904d5f794213ffd6fafb486650587b5fb9c15bd02"
},
"downloads": -1,
"filename": "incendium-2024.5.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "542b52991598ef0ef802b684558c44b7",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": "<3,>=2.7",
"size": 22733,
"upload_time": "2024-05-01T08:02:30",
"upload_time_iso_8601": "2024-05-01T08:02:30.308671Z",
"url": "https://files.pythonhosted.org/packages/b5/dc/4765f1f7cbfc163c305e428007a03a7ccfc03bba9ca02bdb7a4aca23f6be/incendium-2024.5.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "761d59432ff2c2902b8a1924c6ce9ba9026c6bbeb5f760bbfef344f6ecea0df1",
"md5": "6d64770572fcb2daa87930d1844daaab",
"sha256": "c28ccdf8243972addd9fc1f371f83293f7de79e508696ef2f1bc83ab00564515"
},
"downloads": -1,
"filename": "incendium-2024.5.0.tar.gz",
"has_sig": false,
"md5_digest": "6d64770572fcb2daa87930d1844daaab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3,>=2.7",
"size": 19317,
"upload_time": "2024-05-01T08:02:32",
"upload_time_iso_8601": "2024-05-01T08:02:32.083804Z",
"url": "https://files.pythonhosted.org/packages/76/1d/59432ff2c2902b8a1924c6ce9ba9026c6bbeb5f760bbfef344f6ecea0df1/incendium-2024.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 08:02:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ignition-incendium",
"github_project": "incendium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "incendium"
}
JSON
