PyAutomationIO 1.1.4__tar.gz → 1.1.6__tar.gz

pyautomationio-1.1.6/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: PyAutomationIO
+Version: 1.1.6
+Summary: A python framework to develop automation industrial processes applications and Artificial Intelligence applications for the industrial field
+Home-page: https://github.com/know-ai/PyAutomation
+Author: KnowAI
+Author-email: dev.know.ai@gmail.com
+License: GNU AFFERO GENERAL PUBLIC LICENSE
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: System :: Monitoring
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-statemachine==2.4.0
+Requires-Dist: python-statemachine[diagrams]
+Requires-Dist: peewee==3.18.3
+Requires-Dist: psycopg2-binary==2.9.9; sys_platform != "win32"
+Requires-Dist: psycopg2==2.9.9; sys_platform == "win32"
+Requires-Dist: numpy==1.25.0; python_version <= "3.11"
+Requires-Dist: numpy==1.26.0; python_version == "3.12"
+Requires-Dist: numpy==2.0.0; python_version == "3.13"
+Requires-Dist: numpy==2.1.0; python_version >= "3.14"
+Requires-Dist: PyWavelets==1.6.0; python_version == "3.9"
+Requires-Dist: PyWavelets==1.7.0; python_version >= "3.10" and python_version <= "3.11"
+Requires-Dist: PyWavelets==1.9.0; python_version >= "3.12" and python_version <= "3.14"
+Requires-Dist: dash==3.3.0
+Requires-Dist: dash-bootstrap-components==2.0.4
+Requires-Dist: dash-mantine-components==2.4.0
+Requires-Dist: dash-iconify==0.1.2
+Requires-Dist: opcua==0.98.13
+Requires-Dist: python-dotenv==1.2.1
+Requires-Dist: cryptography==43.0.3
+Requires-Dist: Flask-Cors==6.0.1
+Requires-Dist: flask-restx==1.3.2
+Requires-Dist: Flask-SocketIO==5.5.1
+Requires-Dist: gunicorn==23.0.0
+Requires-Dist: websocket-client==1.9.0
+Requires-Dist: gevent-websocket==0.10.1
+Requires-Dist: PyJWT==2.10.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# PyAutomation
+
+[![Documentation Status](https://readthedocs.org/projects/pyautomation/badge/?version=latest)](https://pyautomation.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
+
+**PyAutomation** is a robust, concurrent framework designed for developing industrial automation applications using Python. It bridges the gap between industrial protocols (like OPC UA) and modern software development capabilities, enabling Data Science, AI, and web-based SCADA applications.
+
+![Core Architecture](docs/img/PyAutomationCore.svg)
+
+## Features
+
+- **Concurrency & State Machines**: Built-in support for running multiple state machines concurrently for complex process control and monitoring.
+- **Industrial Connectivity**: Native support for OPC UA (Client & Server) to communicate with PLCs, RTUs, and other industrial devices.
+- **Data Acquisition**:
+  - **DAQ (Data Acquisition)**: Polling-based data collection.
+  - **DAS (Data Acquisition by Subscription)**: Event-driven data collection for efficiency.
+- **CVT (Current Value Table)**: In-memory real-time database for fast access to process variables.
+- **Data Persistence**:
+  - **Historian**: Log historical data to SQL databases (SQLite, PostgreSQL, MySQL).
+  - **Alarms & Events**: Comprehensive alarm management and event logging system compliant with ISA 18.2 concepts.
+- **Web Integration**: Integrated Dash/Flask web server with Socket.IO for real-time HMI/SCADA interfaces.
+- **Extensible**: Easy to extend with custom state machines and logic.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10 or higher
+- pip
+- virtualenv (recommended)
+
+### Local Setup
+
+1.  **Clone the repository:**
+
+    ```bash
+    git clone https://github.com/know-ai/PyAutomation.git
+    cd PyAutomation
+    ```
+
+2.  **Create a virtual environment:**
+
+    ```bash
+    python3 -m venv venv
+    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+    ```
+
+3.  **Install dependencies:**
+
+    ```bash
+    pip install --upgrade pip
+    pip install -r requirements.txt
+    ```
+
+4.  **Run the application:**
+    ```bash
+    ./docker-entrypoint.sh
+    # Or directly with python:
+    # python wsgi.py
+    ```
+
+## Docker Deployment
+
+PyAutomation is container-ready. You can deploy it easily using Docker Compose.
+
+1.  **Create an `.env` file:**
+
+    ```ini
+    AUTOMATION_PORT=8050
+    AUTOMATION_VERSION=1.1.3
+    AUTOMATION_OPCUA_SERVER_PORT=53530
+    AUTOMATION_LOG_MAX_BYTES=5242880  # 5MB
+    AUTOMATION_LOG_BACKUP_COUNT=3
+    ```
+
+2.  **Create a `docker-compose.yml`:**
+
+    ```yaml
+    services:
+      automation:
+        container_name: "Automation"
+        image: "knowai/automation:${AUTOMATION_VERSION}"
+        restart: always
+        ports:
+          - "${AUTOMATION_PORT}:${AUTOMATION_PORT}"
+          - "${AUTOMATION_OPCUA_SERVER_PORT}:${AUTOMATION_OPCUA_SERVER_PORT}"
+        volumes:
+          - automation_db:/app/db
+          - automation_logs:/app/logs
+        environment:
+          OPCUA_SERVER_PORT: ${AUTOMATION_OPCUA_SERVER_PORT}
+          LOG_MAX_BYTES: ${AUTOMATION_LOG_MAX_BYTES}
+          LOG_BACKUP_COUNT: ${AUTOMATION_LOG_BACKUP_COUNT}
+        healthcheck:
+          test: ["CMD", "python", "/app/healthcheck.py"]
+          interval: 15s
+          timeout: 10s
+          retries: 3
+
+    volumes:
+      automation_db:
+      automation_logs:
+    ```
+
+3.  **Start the service:**
+
+    ```bash
+    docker-compose --env-file .env up -d
+    ```
+
+4.  **Access the Dashboard:**
+    Go to `http://localhost:8050` (or your configured port).
+
+## Documentation
+
+Full documentation is available at [Read the Docs](https://pyautomation.readthedocs.io/).
+
+It covers:
+
+- **Architecture**: detailed system design.
+- **User Guide**: how to use the alarms, tags, and database features.
+- **Developer Guide**: API reference and how to build custom state machines.
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to submit pull requests, report issues, and the code of conduct.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

pyautomationio-1.1.6/PyAutomationIO.egg-info/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: PyAutomationIO
+Version: 1.1.6
+Summary: A python framework to develop automation industrial processes applications and Artificial Intelligence applications for the industrial field
+Home-page: https://github.com/know-ai/PyAutomation
+Author: KnowAI
+Author-email: dev.know.ai@gmail.com
+License: GNU AFFERO GENERAL PUBLIC LICENSE
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: System :: Monitoring
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-statemachine==2.4.0
+Requires-Dist: python-statemachine[diagrams]
+Requires-Dist: peewee==3.18.3
+Requires-Dist: psycopg2-binary==2.9.9; sys_platform != "win32"
+Requires-Dist: psycopg2==2.9.9; sys_platform == "win32"
+Requires-Dist: numpy==1.25.0; python_version <= "3.11"
+Requires-Dist: numpy==1.26.0; python_version == "3.12"
+Requires-Dist: numpy==2.0.0; python_version == "3.13"
+Requires-Dist: numpy==2.1.0; python_version >= "3.14"
+Requires-Dist: PyWavelets==1.6.0; python_version == "3.9"
+Requires-Dist: PyWavelets==1.7.0; python_version >= "3.10" and python_version <= "3.11"
+Requires-Dist: PyWavelets==1.9.0; python_version >= "3.12" and python_version <= "3.14"
+Requires-Dist: dash==3.3.0
+Requires-Dist: dash-bootstrap-components==2.0.4
+Requires-Dist: dash-mantine-components==2.4.0
+Requires-Dist: dash-iconify==0.1.2
+Requires-Dist: opcua==0.98.13
+Requires-Dist: python-dotenv==1.2.1
+Requires-Dist: cryptography==43.0.3
+Requires-Dist: Flask-Cors==6.0.1
+Requires-Dist: flask-restx==1.3.2
+Requires-Dist: Flask-SocketIO==5.5.1
+Requires-Dist: gunicorn==23.0.0
+Requires-Dist: websocket-client==1.9.0
+Requires-Dist: gevent-websocket==0.10.1
+Requires-Dist: PyJWT==2.10.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# PyAutomation
+
+[![Documentation Status](https://readthedocs.org/projects/pyautomation/badge/?version=latest)](https://pyautomation.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
+
+**PyAutomation** is a robust, concurrent framework designed for developing industrial automation applications using Python. It bridges the gap between industrial protocols (like OPC UA) and modern software development capabilities, enabling Data Science, AI, and web-based SCADA applications.
+
+![Core Architecture](docs/img/PyAutomationCore.svg)
+
+## Features
+
+- **Concurrency & State Machines**: Built-in support for running multiple state machines concurrently for complex process control and monitoring.
+- **Industrial Connectivity**: Native support for OPC UA (Client & Server) to communicate with PLCs, RTUs, and other industrial devices.
+- **Data Acquisition**:
+  - **DAQ (Data Acquisition)**: Polling-based data collection.
+  - **DAS (Data Acquisition by Subscription)**: Event-driven data collection for efficiency.
+- **CVT (Current Value Table)**: In-memory real-time database for fast access to process variables.
+- **Data Persistence**:
+  - **Historian**: Log historical data to SQL databases (SQLite, PostgreSQL, MySQL).
+  - **Alarms & Events**: Comprehensive alarm management and event logging system compliant with ISA 18.2 concepts.
+- **Web Integration**: Integrated Dash/Flask web server with Socket.IO for real-time HMI/SCADA interfaces.
+- **Extensible**: Easy to extend with custom state machines and logic.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10 or higher
+- pip
+- virtualenv (recommended)
+
+### Local Setup
+
+1.  **Clone the repository:**
+
+    ```bash
+    git clone https://github.com/know-ai/PyAutomation.git
+    cd PyAutomation
+    ```
+
+2.  **Create a virtual environment:**
+
+    ```bash
+    python3 -m venv venv
+    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+    ```
+
+3.  **Install dependencies:**
+
+    ```bash
+    pip install --upgrade pip
+    pip install -r requirements.txt
+    ```
+
+4.  **Run the application:**
+    ```bash
+    ./docker-entrypoint.sh
+    # Or directly with python:
+    # python wsgi.py
+    ```
+
+## Docker Deployment
+
+PyAutomation is container-ready. You can deploy it easily using Docker Compose.
+
+1.  **Create an `.env` file:**
+
+    ```ini
+    AUTOMATION_PORT=8050
+    AUTOMATION_VERSION=1.1.3
+    AUTOMATION_OPCUA_SERVER_PORT=53530
+    AUTOMATION_LOG_MAX_BYTES=5242880  # 5MB
+    AUTOMATION_LOG_BACKUP_COUNT=3
+    ```
+
+2.  **Create a `docker-compose.yml`:**
+
+    ```yaml
+    services:
+      automation:
+        container_name: "Automation"
+        image: "knowai/automation:${AUTOMATION_VERSION}"
+        restart: always
+        ports:
+          - "${AUTOMATION_PORT}:${AUTOMATION_PORT}"
+          - "${AUTOMATION_OPCUA_SERVER_PORT}:${AUTOMATION_OPCUA_SERVER_PORT}"
+        volumes:
+          - automation_db:/app/db
+          - automation_logs:/app/logs
+        environment:
+          OPCUA_SERVER_PORT: ${AUTOMATION_OPCUA_SERVER_PORT}
+          LOG_MAX_BYTES: ${AUTOMATION_LOG_MAX_BYTES}
+          LOG_BACKUP_COUNT: ${AUTOMATION_LOG_BACKUP_COUNT}
+        healthcheck:
+          test: ["CMD", "python", "/app/healthcheck.py"]
+          interval: 15s
+          timeout: 10s
+          retries: 3
+
+    volumes:
+      automation_db:
+      automation_logs:
+    ```
+
+3.  **Start the service:**
+
+    ```bash
+    docker-compose --env-file .env up -d
+    ```
+
+4.  **Access the Dashboard:**
+    Go to `http://localhost:8050` (or your configured port).
+
+## Documentation
+
+Full documentation is available at [Read the Docs](https://pyautomation.readthedocs.io/).
+
+It covers:
+
+- **Architecture**: detailed system design.
+- **User Guide**: how to use the alarms, tags, and database features.
+- **Developer Guide**: API reference and how to build custom state machines.
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to submit pull requests, report issues, and the code of conduct.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

pyautomationio-1.1.6/PyAutomationIO.egg-info/requires.txt

@@ -0,0 +1,44 @@
+python-statemachine==2.4.0
+python-statemachine[diagrams]
+peewee==3.18.3
+dash==3.3.0
+dash-bootstrap-components==2.0.4
+dash-mantine-components==2.4.0
+dash-iconify==0.1.2
+opcua==0.98.13
+python-dotenv==1.2.1
+cryptography==43.0.3
+Flask-Cors==6.0.1
+flask-restx==1.3.2
+Flask-SocketIO==5.5.1
+gunicorn==23.0.0
+websocket-client==1.9.0
+gevent-websocket==0.10.1
+PyJWT==2.10.1
+
+[:python_version <= "3.11"]
+numpy==1.25.0
+
+[:python_version == "3.12"]
+numpy==1.26.0
+
+[:python_version == "3.13"]
+numpy==2.0.0
+
+[:python_version == "3.9"]
+PyWavelets==1.6.0
+
+[:python_version >= "3.10" and python_version <= "3.11"]
+PyWavelets==1.7.0
+
+[:python_version >= "3.12" and python_version <= "3.14"]
+PyWavelets==1.9.0
+
+[:python_version >= "3.14"]
+numpy==2.1.0
+
+[:sys_platform != "win32"]
+psycopg2-binary==2.9.9
+
+[:sys_platform == "win32"]
+psycopg2==2.9.9

pyautomationio-1.1.6/README.md

@@ -0,0 +1,131 @@
+# PyAutomation
+
+[![Documentation Status](https://readthedocs.org/projects/pyautomation/badge/?version=latest)](https://pyautomation.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
+
+**PyAutomation** is a robust, concurrent framework designed for developing industrial automation applications using Python. It bridges the gap between industrial protocols (like OPC UA) and modern software development capabilities, enabling Data Science, AI, and web-based SCADA applications.
+
+![Core Architecture](docs/img/PyAutomationCore.svg)
+
+## Features
+
+- **Concurrency & State Machines**: Built-in support for running multiple state machines concurrently for complex process control and monitoring.
+- **Industrial Connectivity**: Native support for OPC UA (Client & Server) to communicate with PLCs, RTUs, and other industrial devices.
+- **Data Acquisition**:
+  - **DAQ (Data Acquisition)**: Polling-based data collection.
+  - **DAS (Data Acquisition by Subscription)**: Event-driven data collection for efficiency.
+- **CVT (Current Value Table)**: In-memory real-time database for fast access to process variables.
+- **Data Persistence**:
+  - **Historian**: Log historical data to SQL databases (SQLite, PostgreSQL, MySQL).
+  - **Alarms & Events**: Comprehensive alarm management and event logging system compliant with ISA 18.2 concepts.
+- **Web Integration**: Integrated Dash/Flask web server with Socket.IO for real-time HMI/SCADA interfaces.
+- **Extensible**: Easy to extend with custom state machines and logic.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10 or higher
+- pip
+- virtualenv (recommended)
+
+### Local Setup
+
+1.  **Clone the repository:**
+
+    ```bash
+    git clone https://github.com/know-ai/PyAutomation.git
+    cd PyAutomation
+    ```
+
+2.  **Create a virtual environment:**
+
+    ```bash
+    python3 -m venv venv
+    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+    ```
+
+3.  **Install dependencies:**
+
+    ```bash
+    pip install --upgrade pip
+    pip install -r requirements.txt
+    ```
+
+4.  **Run the application:**
+    ```bash
+    ./docker-entrypoint.sh
+    # Or directly with python:
+    # python wsgi.py
+    ```
+
+## Docker Deployment
+
+PyAutomation is container-ready. You can deploy it easily using Docker Compose.
+
+1.  **Create an `.env` file:**
+
+    ```ini
+    AUTOMATION_PORT=8050
+    AUTOMATION_VERSION=1.1.3
+    AUTOMATION_OPCUA_SERVER_PORT=53530
+    AUTOMATION_LOG_MAX_BYTES=5242880  # 5MB
+    AUTOMATION_LOG_BACKUP_COUNT=3
+    ```
+
+2.  **Create a `docker-compose.yml`:**
+
+    ```yaml
+    services:
+      automation:
+        container_name: "Automation"
+        image: "knowai/automation:${AUTOMATION_VERSION}"
+        restart: always
+        ports:
+          - "${AUTOMATION_PORT}:${AUTOMATION_PORT}"
+          - "${AUTOMATION_OPCUA_SERVER_PORT}:${AUTOMATION_OPCUA_SERVER_PORT}"
+        volumes:
+          - automation_db:/app/db
+          - automation_logs:/app/logs
+        environment:
+          OPCUA_SERVER_PORT: ${AUTOMATION_OPCUA_SERVER_PORT}
+          LOG_MAX_BYTES: ${AUTOMATION_LOG_MAX_BYTES}
+          LOG_BACKUP_COUNT: ${AUTOMATION_LOG_BACKUP_COUNT}
+        healthcheck:
+          test: ["CMD", "python", "/app/healthcheck.py"]
+          interval: 15s
+          timeout: 10s
+          retries: 3
+
+    volumes:
+      automation_db:
+      automation_logs:
+    ```
+
+3.  **Start the service:**
+
+    ```bash
+    docker-compose --env-file .env up -d
+    ```
+
+4.  **Access the Dashboard:**
+    Go to `http://localhost:8050` (or your configured port).
+
+## Documentation
+
+Full documentation is available at [Read the Docs](https://pyautomation.readthedocs.io/).
+
+It covers:
+
+- **Architecture**: detailed system design.
+- **User Guide**: how to use the alarms, tags, and database features.
+- **Developer Guide**: API reference and how to build custom state machines.
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to submit pull requests, report issues, and the code of conduct.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.