{"id":35028834,"url":"https://github.com/ignition-devs/ignition-api","last_synced_at":"2026-01-21T03:02:42.458Z","repository":{"id":329013353,"uuid":"1116427916","full_name":"ignition-devs/ignition-api","owner":"ignition-devs","description":"📦 Python package and stubs for the Ignition Scripting API","archived":false,"fork":false,"pushed_at":"2026-01-15T06:49:54.000Z","size":779,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"8.3","last_synced_at":"2026-01-15T13:02:04.427Z","etag":null,"topics":["ignition","inductive-automation","industrial-automation","java","jython","python","python2","scada","stubs"],"latest_commit_sha":null,"homepage":"http://docs.ia.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ignition-devs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"cesarcoatl"}},"created_at":"2025-12-14T20:48:50.000Z","updated_at":"2026-01-08T08:24:26.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ignition-devs/ignition-api","commit_stats":null,"previous_names":["ignition-devs/ignition-api"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ignition-devs/ignition-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ignition-devs%2Fignition-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ignition-devs%2Fignition-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ignition-devs%2Fignition-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ignition-devs%2Fignition-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ignition-devs","download_url":"https://codeload.github.com/ignition-devs/ignition-api/tar.gz/refs/heads/8.3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ignition-devs%2Fignition-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28624341,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T02:47:06.670Z","status":"ssl_error","status_checked_at":"2026-01-21T02:45:44.886Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ignition","inductive-automation","industrial-automation","java","jython","python","python2","scada","stubs"],"created_at":"2025-12-27T06:46:55.743Z","updated_at":"2026-01-21T03:02:42.452Z","avatar_url":"https://github.com/ignition-devs.png","language":"Python","funding_links":["https://github.com/sponsors/cesarcoatl"],"categories":[],"sub_categories":[],"readme":"# ignition-api 8.3\n\n\u003c!--- Badges ---\u003e\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ignition-api)](https://pypi.org/project/ignition-api/)\n[![PyPI - Version](https://img.shields.io/pypi/v/ignition-api)](https://pypi.org/project/ignition-api/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/ignition-api)](https://pepy.tech/projects/ignition-api)\n[![ignition-api](https://snyk.io/advisor/python/ignition-api/badge.svg)](https://snyk.io/advisor/python/ignition-api)\n[![ci](https://github.com/ignition-devs/ignition-api/actions/workflows/ci.yml/badge.svg?branch=8.3)](https://github.com/ignition-devs/ignition-api/actions/workflows/ci.yml)\n[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/orgs/ignition-devs/discussions)\n\n`ignition-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- [Stubs](#stubs)\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- [Disclaimer](#disclaimer)\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\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\u003e\u003e\u003e from __future__ import print_function\n\u003e\u003e\u003e import system.util\n\u003e\u003e\u003e 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\u003e\u003e\u003e system.util.beep()\n\u003e\u003e\u003e quit()\n```\n\nAnd to uninstall:\n\n```bash\npython2 -m pip uninstall ignition-api\n```\n\n## Stubs\n\n[`ignition-api-stubs`] is a companion package that provides Python type stubs\n(`.pyi` files) for the Ignition Scripting API. Type stubs enable static type\nchecking and enhanced IDE support for code that depends on `ignition-api`.\n\nThe recommended use of `ignition-api-stubs` is to enable type checking of your\nIgnition scripting code using [`mypy`]. This allows you to catch type-related\nerrors during development before deploying to your Ignition gateway.\n\n## Project structure\n\n### Packages\n\nThis project consists of the following packages:\n\n- com\n  - codahale\n  - [google](#comgoogle)\n  - [inductiveautomation](#cominductiveautomation)\n  - palantir\n- org\n  - [apache](#orgapache)\n  - [bson](#orgbson)\n  - [json](#orgjson)\n  - [python](#orgpython)\n  - [slf4j](#orgslf4j)\n- [system](#system)\n\n#### com.google\n\nThis package includes supporting classes and interfaces from Guava: Google Core\nLibraries for Java 32.0.1-jre API. For more information, see documentation here:\n\u003chttps://javadoc.io/doc/com.google.guava/guava/32.0.1-jre/index.html\u003e\n\n#### com.inductiveautomation\n\nThis package includes supporting Inductive Automation's classes and interfaces.\nFor more information, see documentation here:\n\u003chttps://files.inductiveautomation.com/sdk/javadoc/ignition83/8.3.3/index.html\u003e.\n\n#### org.apache\n\n##### org.apache.commons.lang3\n\nThis package includes supporting classes and interfaces from Apache Commons Lang\n3.11 API. For more information, see documentation here:\n\u003chttps://javadoc.io/doc/org.apache.commons/commons-lang3/3.11/index.html\u003e\n\n##### org.apache.commons.math3\n\nThis package includes supporting classes and interfaces from Apache Commons Math\n3.6.1 API. For more information, see documentation here:\n\u003chttps://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.html\u003e\n\n##### org.apache.commons.poi\n\nThis package includes supporting classes and interfaces from Apache POI 4.1.2\nAPI. For more information, see documentation here:\n\u003chttps://www.javadoc.io/doc/org.apache.poi/poi/4.1.2/index.html\u003e\n\n#### org.bson\n\nThis package includes supporting classes and interfaces from Mongo Java driver\n4.8.1, see documentation here:\n\u003chttps://javadoc.io/doc/org.mongodb/bson/4.8.1/index.html\u003e\n\n#### org.json\n\nThis package includes supporting classes and interfaces from the Inductive\nAutomation's `org.json` package, see documentation here:\n\u003chttps://files.inductiveautomation.com/sdk/javadoc/ignition83/8.3.3/org/json/package-summary.html\u003e\n\n#### org.python\n\nThis package includes supporting Jython classes and interfaces. For more\ninformation, see documentation here:\n\u003chttps://www.javadoc.io/doc/org.python/jython-standalone/2.7.3/index.html\u003e.\n\n#### org.slf4j\n\nThis package includes supporting classes and interfaces from SLF4J API Module.\nFor more information, see documentation here:\n\u003chttps://www.javadoc.io/doc/org.slf4j/slf4j-api/2.0.12/index.html\u003e.\n\n#### system\n\nThis package includes all Ignition Scripting Functions. For more information,\nsee documentation here:\n\u003chttps://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions\u003e.\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## Disclaimer\n\nThis project is not an official product of Inductive Automation. Ignition is a\ntrademark of Inductive Automation. This package is community-maintained and\nprovided as-is for development assistance purposes.\n\n\u003c!-- Links --\u003e\n[CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/main/CONTRIBUTING.md#contributing-to-ignition-api\n[CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api/graphs/contributors\n[Discussions]: https://github.com/orgs/ignition-devs/discussions\n[`ignition-api-stubs`]: https://pypi.org/project/ignition-api-stubs\n[Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions\n[LICENSE]: https://github.com/ignition-devs/ignition-api/blob/main/LICENSE\n[Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/\n[`mypy`]: https://coatl-mypy.readthedocs.io/en/v0.971/\n[Python 2.7.18]: https://www.python.org/downloads/release/python-2718/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fignition-devs%2Fignition-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fignition-devs%2Fignition-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fignition-devs%2Fignition-api/lists"}