ignition-api 8.3.7__tar.gz → 8.3.8__tar.gz

{ignition_api-8.3.7 → ignition_api-8.3.8}/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 8.3.8 (2026-07-17)
+
+### Feat
+
+- **system**: add config submodule (#56)
+
+### Refactor
+
+- **system**: add system.secrets functions (#57)
+
 ## 8.3.7 (2026-06-10)
 
 ### Feat

{ignition_api-8.3.7 → ignition_api-8.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ignition_api
-Version: 8.3.7
+Version: 8.3.8
 Summary: Ignition Scripting API
 Home-page: https://github.com/ignition-devs/ignition-api
 Author: César Román
@@ -16,17 +16,16 @@ Description: # ignition-api 8.3
         [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ignition-api)](https://pypi.org/project/ignition-api/)
         [![PyPI - Version](https://img.shields.io/pypi/v/ignition-api)](https://pypi.org/project/ignition-api/)
         [![PyPI - Downloads](https://static.pepy.tech/badge/ignition-api)](https://pepy.tech/projects/ignition-api)
-        [![ci](https://github.com/ignition-devs/ignition-api/actions/workflows/ci.yml/badge.svg?branch=8.3)](https://githubcom/ignition-devs/ignition-api/actions/workflows/ci.yml)
+        [![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)
         [![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/orgs/ignition-devs/discussions)
         
-        `ignition-api` is a Python package that allows developers to get code completion
-        for Ignition Scripting API scripting functions in their IDE of choice.
+        ignition-api is a Python package that allows developers to get code completion
+        for Ignition Scripting API functions in their IDE of choice.
         
         ## Table of contents
         
         - [Prerequisites](#prerequisites)
-        - [Installation and usage](#installation-and-usage)
-          - [Installing with pip](#installing-with-pip)
+        - [Installation](#installation)
         - [Stubs](#stubs)
         - [Project structure](#project-structure)
           - [Packages](#packages)
@@ -41,23 +40,20 @@ Description: # ignition-api 8.3
         
         Before you begin, ensure you have met the following requirements:
         
-        - You have installed [Python 2.7.18]
-        - You are familiar with [Ignition System Functions]
+        - [Python 2.7.18]
+        - Familiarity with [Ignition System Functions]
         
-        ## Installation and usage
+        ## Installation
         
-        ### Installing with `pip`
-        
-        The preferred method is to install it by running `pip`. It requires Python
-        2.7.18.
+        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.
+        This installs the package to your Python 2 installation, allowing you to
+        call Ignition Scripting functions from Python's REPL and get code completion
+        in IDEs such as PyCharm and Visual Studio Code.
         
         ```bash
         $ python2
@@ -76,7 +72,7 @@ Description: # ignition-api 8.3
         >>> quit()
         ```
         
-        And to uninstall:
+        To uninstall:
         
         ```bash
         python2 -m pip uninstall ignition-api
@@ -88,10 +84,6 @@ Description: # ignition-api 8.3
         (`.pyi` files) for the Ignition Scripting API. Type stubs enable static type
         checking and enhanced IDE support for code that depends on `ignition-api`.
         
-        The recommended use of `ignition-api-stubs` is to enable type checking of your
-        Ignition scripting code using [`mypy`]. This allows you to catch type-related
-        errors during development before deploying to your Ignition gateway.
-        
         ## Project structure
         
         ### Packages
@@ -121,7 +113,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting Inductive Automation's classes and interfaces.
         For more information, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/index.html>.
         
         #### org.apache
         
@@ -153,13 +145,13 @@ Description: # ignition-api 8.3
         
         This package includes supporting classes and interfaces from the Inductive
         Automation's `org.json` package, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/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>.
+        <https://www.javadoc.io/doc/org.python/jython-standalone/2.7.4/index.html>.
         
         #### org.slf4j
         
@@ -202,14 +194,13 @@ Description: # ignition-api 8.3
         provided as-is for development assistance purposes.
         
         <!-- Links -->
-        [CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/main/CONTRIBUTING.md#contributing-to-ignition-api
+        [CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/8.3/CONTRIBUTING.md#contributing-to-ignition-api
         [CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api/graphs/contributors
         [Discussions]: https://github.com/orgs/ignition-devs/discussions
         [`ignition-api-stubs`]: https://pypi.org/project/ignition-api-stubs
         [Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions
-        [LICENSE]: https://github.com/ignition-devs/ignition-api/blob/main/LICENSE
+        [LICENSE]: https://github.com/ignition-devs/ignition-api/blob/8.3/LICENSE
         [Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/
-        [`mypy`]: https://coatl-mypy.readthedocs.io/en/v0.971/
         [Python 2.7.18]: https://www.python.org/downloads/release/python-2718/
         
 Keywords: hmi,ignition,inductive automation,scada

{ignition_api-8.3.7 → ignition_api-8.3.8}/README.md

@@ -4,17 +4,16 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ignition-api)](https://pypi.org/project/ignition-api/)
 [![PyPI - Version](https://img.shields.io/pypi/v/ignition-api)](https://pypi.org/project/ignition-api/)
 [![PyPI - Downloads](https://static.pepy.tech/badge/ignition-api)](https://pepy.tech/projects/ignition-api)
-[![ci](https://github.com/ignition-devs/ignition-api/actions/workflows/ci.yml/badge.svg?branch=8.3)](https://githubcom/ignition-devs/ignition-api/actions/workflows/ci.yml)
+[![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)
 [![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/orgs/ignition-devs/discussions)
 
-`ignition-api` is a Python package that allows developers to get code completion
-for Ignition Scripting API scripting functions in their IDE of choice.
+ignition-api is a Python package that allows developers to get code completion
+for Ignition Scripting API functions in their IDE of choice.
 
 ## Table of contents
 
 - [Prerequisites](#prerequisites)
-- [Installation and usage](#installation-and-usage)
-  - [Installing with pip](#installing-with-pip)
+- [Installation](#installation)
 - [Stubs](#stubs)
 - [Project structure](#project-structure)
   - [Packages](#packages)
@@ -29,23 +28,20 @@ for Ignition Scripting API scripting functions in their IDE of choice.
 
 Before you begin, ensure you have met the following requirements:
 
-- You have installed [Python 2.7.18]
-- You are familiar with [Ignition System Functions]
+- [Python 2.7.18]
+- Familiarity with [Ignition System Functions]
 
-## Installation and usage
+## Installation
 
-### Installing with `pip`
-
-The preferred method is to install it by running `pip`. It requires Python
-2.7.18.
+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.
+This installs the package to your Python 2 installation, allowing you to
+call Ignition Scripting functions from Python's REPL and get code completion
+in IDEs such as PyCharm and Visual Studio Code.
 
 ```bash
 $ python2
@@ -64,7 +60,7 @@ Client data, as well as interact with other various systems.
 >>> quit()
 ```
 
-And to uninstall:
+To uninstall:
 
 ```bash
 python2 -m pip uninstall ignition-api
@@ -76,10 +72,6 @@ python2 -m pip uninstall ignition-api
 (`.pyi` files) for the Ignition Scripting API. Type stubs enable static type
 checking and enhanced IDE support for code that depends on `ignition-api`.
 
-The recommended use of `ignition-api-stubs` is to enable type checking of your
-Ignition scripting code using [`mypy`]. This allows you to catch type-related
-errors during development before deploying to your Ignition gateway.
-
 ## Project structure
 
 ### Packages
@@ -109,7 +101,7 @@ Libraries for Java 32.0.1-jre API. For more information, see documentation here:
 
 This package includes supporting Inductive Automation's classes and interfaces.
 For more information, see documentation here:
-<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
+<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/index.html>.
 
 #### org.apache
 
@@ -141,13 +133,13 @@ This package includes supporting classes and interfaces from Mongo Java driver
 
 This package includes supporting classes and interfaces from the Inductive
 Automation's `org.json` package, see documentation here:
-<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
+<https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/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>.
+<https://www.javadoc.io/doc/org.python/jython-standalone/2.7.4/index.html>.
 
 #### org.slf4j
 
@@ -190,12 +182,11 @@ trademark of Inductive Automation. This package is community-maintained and
 provided as-is for development assistance purposes.
 
 <!-- Links -->
-[CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/main/CONTRIBUTING.md#contributing-to-ignition-api
+[CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/8.3/CONTRIBUTING.md#contributing-to-ignition-api
 [CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api/graphs/contributors
 [Discussions]: https://github.com/orgs/ignition-devs/discussions
 [`ignition-api-stubs`]: https://pypi.org/project/ignition-api-stubs
 [Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions
-[LICENSE]: https://github.com/ignition-devs/ignition-api/blob/main/LICENSE
+[LICENSE]: https://github.com/ignition-devs/ignition-api/blob/8.3/LICENSE
 [Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/
-[`mypy`]: https://coatl-mypy.readthedocs.io/en/v0.971/
 [Python 2.7.18]: https://www.python.org/downloads/release/python-2718/

{ignition_api-8.3.7 → ignition_api-8.3.8}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ignition_api
-version = 8.3.7
+version = 8.3.8
 description = Ignition Scripting API
 long_description = file: README.md
 long_description_content_type = text/markdown

ignition_api-8.3.8/src/com/inductiveautomation/ignition/gateway/script/__init__.py

@@ -0,0 +1,88 @@
+from __future__ import print_function
+
+__all__ = ["PyResource"]
+
+from typing import Any, List, Mapping, Optional, Union
+
+from java.util import Date
+
+from org.python.core import PyObject, PyTuple
+
+
+class PyResource(PyObject):
+    def __init__(self, resource=None):
+        # type: (Any) -> None
+        super(PyResource, self).__init__()
+        print(resource)
+
+    def getCollection(self):
+        # type: () -> Union[str, unicode]
+        pass
+
+    def getDefiningCollection(self):
+        # type: () -> Union[str, unicode]
+        pass
+
+    def getName(self):
+        # type: () -> Optional[Union[str, unicode]]
+        pass
+
+    def getResourceType(self):
+        # type: () -> PyTuple
+        pass
+
+    def getDocumentation(self):
+        # type: () -> Optional[Union[str, unicode]]
+        pass
+
+    def getFiles(self):
+        # type: () -> Mapping[Union[str, unicode], Any]
+        pass
+
+    def getFile(self, key):
+        # type: (Union[str, unicode]) -> Any
+        pass
+
+    def getConfig(self):
+        # type: () -> Any
+        pass
+
+    def getBackupConfig(self):
+        # type: () -> Any
+        pass
+
+    def getFileNames(self):
+        # type: () -> List[Union[str, unicode]]
+        pass
+
+    def getAttributes(self):
+        # type: () -> PyObject
+        pass
+
+    def getAttribute(self, key):
+        # type: (Union[str, unicode]) -> PyObject
+        pass
+
+    def getId(self):
+        # type: () -> Optional[Union[str, unicode]]
+        pass
+
+    def getLastModificationActor(self):
+        # type: () -> Optional[Union[str, unicode]]
+        pass
+
+    def getLastModificationTime(self):
+        # type: () -> Optional[Date]
+        pass
+
+    def getResource(self):
+        # type: () -> Any
+        pass
+
+    def isEnabled(self):
+        # type: () -> bool
+        pass
+
+    def isSingleton(self):
+        # type: () -> bool
+        pass

{ignition_api-8.3.7 → ignition_api-8.3.8}/src/com/inductiveautomation/ignition/gateway/secrets/__init__.py

@@ -1,7 +1,7 @@
 from typing import Optional, Union
 
 from java.io import Closeable
-from java.lang import Object
+from java.lang import Exception, Object, Throwable
 from java.nio.charset import Charset
 
 
@@ -35,3 +35,9 @@ class Plaintext(Object, Closeable):
     def getBytes(self):
         # type: () -> bytearray
         pass
+
+
+class SecretException(Exception):
+    def __init__(self, message, cause=None):
+        # type: (str, Optional[Throwable]) -> None
+        super(SecretException, self).__init__(message, cause)

{ignition_api-8.3.7 → ignition_api-8.3.8}/src/ignition_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ignition-api
-Version: 8.3.7
+Version: 8.3.8
 Summary: Ignition Scripting API
 Home-page: https://github.com/ignition-devs/ignition-api
 Author: César Román
@@ -16,17 +16,16 @@ Description: # ignition-api 8.3
         [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ignition-api)](https://pypi.org/project/ignition-api/)
         [![PyPI - Version](https://img.shields.io/pypi/v/ignition-api)](https://pypi.org/project/ignition-api/)
         [![PyPI - Downloads](https://static.pepy.tech/badge/ignition-api)](https://pepy.tech/projects/ignition-api)
-        [![ci](https://github.com/ignition-devs/ignition-api/actions/workflows/ci.yml/badge.svg?branch=8.3)](https://githubcom/ignition-devs/ignition-api/actions/workflows/ci.yml)
+        [![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)
         [![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/orgs/ignition-devs/discussions)
         
-        `ignition-api` is a Python package that allows developers to get code completion
-        for Ignition Scripting API scripting functions in their IDE of choice.
+        ignition-api is a Python package that allows developers to get code completion
+        for Ignition Scripting API functions in their IDE of choice.
         
         ## Table of contents
         
         - [Prerequisites](#prerequisites)
-        - [Installation and usage](#installation-and-usage)
-          - [Installing with pip](#installing-with-pip)
+        - [Installation](#installation)
         - [Stubs](#stubs)
         - [Project structure](#project-structure)
           - [Packages](#packages)
@@ -41,23 +40,20 @@ Description: # ignition-api 8.3
         
         Before you begin, ensure you have met the following requirements:
         
-        - You have installed [Python 2.7.18]
-        - You are familiar with [Ignition System Functions]
+        - [Python 2.7.18]
+        - Familiarity with [Ignition System Functions]
         
-        ## Installation and usage
+        ## Installation
         
-        ### Installing with `pip`
-        
-        The preferred method is to install it by running `pip`. It requires Python
-        2.7.18.
+        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.
+        This installs the package to your Python 2 installation, allowing you to
+        call Ignition Scripting functions from Python's REPL and get code completion
+        in IDEs such as PyCharm and Visual Studio Code.
         
         ```bash
         $ python2
@@ -76,7 +72,7 @@ Description: # ignition-api 8.3
         >>> quit()
         ```
         
-        And to uninstall:
+        To uninstall:
         
         ```bash
         python2 -m pip uninstall ignition-api
@@ -88,10 +84,6 @@ Description: # ignition-api 8.3
         (`.pyi` files) for the Ignition Scripting API. Type stubs enable static type
         checking and enhanced IDE support for code that depends on `ignition-api`.
         
-        The recommended use of `ignition-api-stubs` is to enable type checking of your
-        Ignition scripting code using [`mypy`]. This allows you to catch type-related
-        errors during development before deploying to your Ignition gateway.
-        
         ## Project structure
         
         ### Packages
@@ -121,7 +113,7 @@ Description: # ignition-api 8.3
         
         This package includes supporting Inductive Automation's classes and interfaces.
         For more information, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html>.
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/index.html>.
         
         #### org.apache
         
@@ -153,13 +145,13 @@ Description: # ignition-api 8.3
         
         This package includes supporting classes and interfaces from the Inductive
         Automation's `org.json` package, see documentation here:
-        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html>
+        <https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.8/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>.
+        <https://www.javadoc.io/doc/org.python/jython-standalone/2.7.4/index.html>.
         
         #### org.slf4j
         
@@ -202,14 +194,13 @@ Description: # ignition-api 8.3
         provided as-is for development assistance purposes.
         
         <!-- Links -->
-        [CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/main/CONTRIBUTING.md#contributing-to-ignition-api
+        [CONTRIBUTING.md]: https://github.com/ignition-devs/ignition-api/blob/8.3/CONTRIBUTING.md#contributing-to-ignition-api
         [CONTRIBUTORS]: https://github.com/ignition-devs/ignition-api/graphs/contributors
         [Discussions]: https://github.com/orgs/ignition-devs/discussions
         [`ignition-api-stubs`]: https://pypi.org/project/ignition-api-stubs
         [Ignition System Functions]: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions
-        [LICENSE]: https://github.com/ignition-devs/ignition-api/blob/main/LICENSE
+        [LICENSE]: https://github.com/ignition-devs/ignition-api/blob/8.3/LICENSE
         [Microsoft Open Source Code of Conduct]: https://opensource.microsoft.com/codeofconduct/
-        [`mypy`]: https://coatl-mypy.readthedocs.io/en/v0.971/
         [Python 2.7.18]: https://www.python.org/downloads/release/python-2718/
         
 Keywords: hmi,ignition,inductive automation,scada

{ignition_api-8.3.7 → ignition_api-8.3.8}/src/ignition_api.egg-info/SOURCES.txt

@@ -106,6 +106,7 @@ src/com/inductiveautomation/ignition/common/xmlserialization/serialization/__ini
 src/com/inductiveautomation/ignition/common/xmlserialization/serialization/equalitydelegates/__init__.py
 src/com/inductiveautomation/ignition/gateway/__init__.py
 src/com/inductiveautomation/ignition/gateway/project/__init__.py
+src/com/inductiveautomation/ignition/gateway/script/__init__.py
 src/com/inductiveautomation/ignition/gateway/secrets/__init__.py
 src/com/inductiveautomation/ignition/modules/__init__.py
 src/com/inductiveautomation/ignition/modules/serial/__init__.py
@@ -185,6 +186,7 @@ src/org/slf4j/event/__init__.py
 src/system/__init__.py
 src/system/__version__.py
 src/system/alarm.py
+src/system/config.py
 src/system/dataset.py
 src/system/date.py
 src/system/db.py

ignition_api-8.3.8/src/system/__version__.py

@@ -0,0 +1,4 @@
+"""Package information."""
+
+__version__ = "8.3.8"
+__build__ = "2026071409"