# ignition-api 8.1
<!--- Badges --->
[](https://pepy.tech/project/ignition-api)
[](https://snyk.io//advisor/python/ignition-api)
ignition-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 contents
- [Prerequisites](#prerequisites)
- [Installation and usage](#installation-and-usage)
- [Installing with pip](#installing-with-pip)
- [Downloading from releases](#downloading-from-releases)
- [Using as a dependency in PyCharm](#using-as-a-dependency-in-pycharm)
- [Project structure](#project-structure)
- [Packages](#packages)
- [Contributing](#contributing)
- [Discussions](#discussions)
- [Contributors](#contributors)
- [License](#license)
- [Code of conduct](#code-of-conduct)
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed [Python 2.7.18]
- You are familiar with [Ignition System Functions]
## Installation and usage
To use ignition-api, 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 such as PyCharm and 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 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
```
### Downloading from releases
You may also download the code targeted to your desired version from [releases]
and add it as a dependency to your scripting project.
#### Using as a dependency in PyCharm
To include ignition-api as a dependency in PyCharm, you will need to attach it
to your project.
1. Clone the repo or download from [releases]
1. With your project open where you want to include `ignition-api`, navigate to
`File > Open` and select the `ignition-api` project folder
1. Choose `Attach` when prompted
1. Under the `ignitition-api` project folder, right-click on the `src/` folder
and choose `Mark Directory as > Sources Root`
## Project structure
### Packages
This project 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.44/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/17/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.json
This package includes supporting classes and interfaces from the Inductive
Automation's `org.json` package, see documentation here:
<https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.44/org/json/package-summary.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.3/index.html>.
#### org.slf4j
This 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>.
#### system
This package includes all Ignition Scripting Functions. For more information,
see documentation here:
<https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions>.
## Contributing
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 can be found here: [CONTRIBUTORS].
## License
See the [LICENSE].
## Code of conduct
This project has adopted the [Microsoft Open Source Code of Conduct].
<!-- Links -->
[CONTRIBUTING.md]: ./CONTRIBUTING.md#contributing-to-ignition-api
[CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api-8.1/graphs/contributors
[Discussions]: https://github.com/ignition-devs/discussions/discussions
[Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions
[LICENSE]: ./LICENSE
[Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/
[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/
[releases]: https://github.com/ignition-devs/ignition-api-8.1/releases
Raw data
{
"_id": null,
"home_page": "https://ignition-devs.github.io/ignition-api-8.1",
"name": "ignition-api",
"maintainer": null,
"docs_url": null,
"requires_python": "==2.7.18",
"maintainer_email": null,
"keywords": "hmi, ignition, inductive automation, scada",
"author": "C\u00e9sar Rom\u00e1n",
"author_email": "cesar@coatl.dev",
"download_url": "https://files.pythonhosted.org/packages/47/14/b5a3eba03520970a97426b81df07a195f3d56eaa077691bce3814d281b00/ignition_api-8.1.44.post1.tar.gz",
"platform": null,
"description": "# ignition-api 8.1\n\n<!--- Badges --->\n[](https://pepy.tech/project/ignition-api)\n[](https://snyk.io//advisor/python/ignition-api)\n\nignition-api is a Python package that allows developers to get code completion\nfor Ignition Scripting API scripting functions in their IDE of choice.\n\n## Table of contents\n\n- [Prerequisites](#prerequisites)\n- [Installation and usage](#installation-and-usage)\n - [Installing with pip](#installing-with-pip)\n - [Downloading from releases](#downloading-from-releases)\n - [Using as a dependency in PyCharm](#using-as-a-dependency-in-pycharm)\n- [Project structure](#project-structure)\n - [Packages](#packages)\n- [Contributing](#contributing)\n- [Discussions](#discussions)\n- [Contributors](#contributors)\n- [License](#license)\n- [Code of conduct](#code-of-conduct)\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- You have installed [Python 2.7.18]\n- You are familiar with [Ignition System Functions]\n\n## Installation and usage\n\nTo use ignition-api, you may install it by doing any of the following.\n\n### Installing with `pip`\n\nThe preferred method is to install it by running `pip`. It requires Python\n2.7.18.\n\n```bash\npython2 -m pip install ignition-api\n```\n\nThis will install it as package to your Python installation, which will allow\nyou to call Ignition Scripting functions from Python's REPL, and get code\ncompletion using an IDE such as PyCharm and 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 system.util\n>>> print(system.util.__doc__)\nUtility Functions.\n\nThe following functions give you access to view various Gateway and\nClient data, as well as interact with other various systems.\n\n>>> system.util.beep()\n>>> quit()\n```\n\nAnd to uninstall:\n\n```bash\npython2 -m pip uninstall ignition-api\n```\n\n### Downloading from releases\n\nYou may also download the code targeted to your desired version from [releases]\nand add it as a dependency to your scripting project.\n\n#### Using as a dependency in PyCharm\n\nTo include ignition-api as a dependency in PyCharm, you will need to attach it\nto your project.\n\n1. Clone the repo or download from [releases]\n1. With your project open where you want to include `ignition-api`, navigate to\n `File > Open` and select the `ignition-api` project folder\n1. Choose `Attach` when prompted\n1. Under the `ignitition-api` project folder, right-click on the `src/` folder\n and choose `Mark Directory as > Sources Root`\n\n## Project structure\n\n### Packages\n\nThis project consists of the following packages:\n\n- com.inductiveautomation\n- java\n- javax\n- org\n- system\n\n#### com.inductiveautomation\n\nThis package includes supporting Inductive Automation's classes and interfaces.\nFor more information, see documentation here:\n<https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.44/index.html>.\n\n#### java/javax\n\nThese packages include supporting Java classes and interfaces. For more\ninformation, see documentation here:\n<https://docs.oracle.com/en/java/javase/17/docs/api/index.html>.\n\n#### org.apache\n\nThis package includes supporting classes and interfaces from Apache Commons Math\nAPI. For more information, see documentation here:\n<https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.html>\n\n#### org.json\n\nThis package includes supporting classes and interfaces from the Inductive\nAutomation's `org.json` package, see documentation here:\n<https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.44/org/json/package-summary.html>\n\n#### org.python\n\nThis package includes supporting Jython classes and interfaces. For more\ninformation, see documentation here:\n<https://www.javadoc.io/doc/org.python/jython-standalone/2.7.3/index.html>.\n\n#### org.slf4j\n\nThis package includes supporting classes and interfaces from SLF4J API Module.\nFor more information, see documentation here:\n<https://www.javadoc.io/doc/org.slf4j/slf4j-api/1.7.26/overview-summary.html>.\n\n#### system\n\nThis package includes all Ignition Scripting Functions. For more information,\nsee documentation here:\n<https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions>.\n\n## Contributing\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 can be found here: [CONTRIBUTORS].\n\n## License\n\nSee the [LICENSE].\n\n## Code of conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct].\n\n<!-- Links -->\n[CONTRIBUTING.md]: ./CONTRIBUTING.md#contributing-to-ignition-api\n[CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api-8.1/graphs/contributors\n[Discussions]: https://github.com/ignition-devs/discussions/discussions\n[Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions\n[LICENSE]: ./LICENSE\n[Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/\n[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/\n[releases]: https://github.com/ignition-devs/ignition-api-8.1/releases\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ignition Scripting API",
"version": "8.1.44.post1",
"project_urls": {
"Documentation": "https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions",
"Funding": "https://github.com/sponsors/cesarcoatl",
"Homepage": "https://ignition-devs.github.io/ignition-api-8.1",
"Source": "https://github.com/ignition-devs/ignition-api-8.1",
"Tracker": "https://github.com/ignition-devs/ignition-api-8.1/issues"
},
"split_keywords": [
"hmi",
" ignition",
" inductive automation",
" scada"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e53a950dce98a2f8cb16be12f71b9795e45dd2050cd95d2c8a6f731befe4a09",
"md5": "8c74c41b6910d57cc2995d56cfaa31f4",
"sha256": "5ed053398488c16cb18d8c250c87a1b6bb39c02fbaa5a58d7fd892074e1b76b9"
},
"downloads": -1,
"filename": "ignition_api-8.1.44.post1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "8c74c41b6910d57cc2995d56cfaa31f4",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": "==2.7.18",
"size": 242913,
"upload_time": "2024-11-06T19:04:03",
"upload_time_iso_8601": "2024-11-06T19:04:03.057920Z",
"url": "https://files.pythonhosted.org/packages/2e/53/a950dce98a2f8cb16be12f71b9795e45dd2050cd95d2c8a6f731befe4a09/ignition_api-8.1.44.post1-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4714b5a3eba03520970a97426b81df07a195f3d56eaa077691bce3814d281b00",
"md5": "5a49e334256f448147e89eaf8f9c9af6",
"sha256": "25ee31c8cddb8da6873addab10dff075b6535c26873ce8411fb70c70215cc9ba"
},
"downloads": -1,
"filename": "ignition_api-8.1.44.post1.tar.gz",
"has_sig": false,
"md5_digest": "5a49e334256f448147e89eaf8f9c9af6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==2.7.18",
"size": 176058,
"upload_time": "2024-11-06T19:04:04",
"upload_time_iso_8601": "2024-11-06T19:04:04.385386Z",
"url": "https://files.pythonhosted.org/packages/47/14/b5a3eba03520970a97426b81df07a195f3d56eaa077691bce3814d281b00/ignition_api-8.1.44.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 19:04:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "cesarcoatl",
"github_not_found": true,
"lcname": "ignition-api"
}
JSON
