industrial-connect 0.1.0__tar.gz

industrial_connect-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Kristjan Cuznar
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

industrial_connect-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md LICENSE pyproject.toml
+recursive-include docs *.md
+include manage.py
+recursive-include examples *.py *.md
+include examples/.env.example
+recursive-include tests *.py *.md *.yaml *.conf
+recursive-include tools *.py
+exclude dev.py

industrial_connect-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: industrial-connect
+Version: 0.1.0
+Summary: Small, independently usable industrial Python connectors
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: env
+Requires-Dist: python-dotenv<2,>=1.2.4; extra == "env"
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]<4,>=3.3.6; extra == "postgres"
+Requires-Dist: psycopg-pool<4,>=3.3.3; extra == "postgres"
+Provides-Extra: oracle
+Requires-Dist: oracledb<27,>=26.0.1; extra == "oracle"
+Provides-Extra: mssql
+Requires-Dist: pymssql<3,>=2.4.5; extra == "mssql"
+Provides-Extra: questdb
+Requires-Dist: questdb<7,>=6.0; extra == "questdb"
+Provides-Extra: sqlite
+Provides-Extra: opcua
+Requires-Dist: asyncua<3,>=2.1; extra == "opcua"
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt<3,>=2.1; extra == "mqtt"
+Provides-Extra: graylog
+Requires-Dist: graypy<3,>=2.1; extra == "graylog"
+Provides-Extra: db
+Requires-Dist: industrial-connect[mssql,oracle,postgres,questdb,sqlite]==0.1.0; extra == "db"
+Provides-Extra: all
+Requires-Dist: industrial-connect[db,env,graylog,mqtt,opcua]==0.1.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest<10,>=8.3; extra == "dev"
+Requires-Dist: build<2,>=1.2; extra == "dev"
+Requires-Dist: twine<7,>=6; extra == "dev"
+Requires-Dist: ruff<1,>=0.14; extra == "dev"
+Requires-Dist: pyright<2,>=1.1.414; extra == "dev"
+Dynamic: license-file
+
+# industrial-connect
+
+Reusable Python connectors for industrial applications. Python 3.12+, Windows and Linux.
+Optional drivers, explicit resource ownership, no import-time connections.
+
+## Install
+
+```shell
+pip install industrial-connect                    # SQLite and core
+pip install "industrial-connect[postgres,env]"
+pip install "industrial-connect[mqtt,opcua]"
+pip install "industrial-connect[all]"
+```
+
+Install only the drivers you need. Pin the tested library version and lock your
+application's dependencies. `db` includes every database; `all` includes every extra.
+
+## Connectors and runnable examples
+
+Each guide includes configuration, a realistic example, resource lifetime and error behavior.
+Run examples from the checkout; `--help` lists the available options.
+
+| Connector | Extra | Guide | Example |
+| --- | --- | --- | --- |
+| PostgreSQL | `postgres` | [PostgreSQL](docs/postgres.md) | `python -m examples.postgres` |
+| Oracle | `oracle` | [Oracle and PL/SQL](docs/oracle.md) | `python -m examples.oracle` |
+| SQL Server | `mssql` | [SQL Server](docs/mssql.md) | `python -m examples.mssql` |
+| SQLite | none | [SQLite](docs/sqlite.md) | `python -m examples.sqlite` |
+| QuestDB QWP | `questdb` | [WebSocket ingestion and SQL](docs/questdb.md) | `python -m examples.questdb` |
+| MQTT | `mqtt` | [Queue or callback telemetry](docs/mqtt.md) | `python -m examples.mqtt` / `examples.mqtt_callback` |
+| OPC UA | `opcua` | [PLC reads, writes and subscriptions](docs/opcua.md) | `python -m examples.opcua` |
+| Console/files | none | [Logging](docs/logging.md) | `python -m examples.logging_setup` |
+| Graylog | `graylog` | [GELF/UDP](docs/graylog.md) | `python -m examples.graylog` |
+
+## Quick start without a service
+
+```python
+from industrial_connect.db import SqliteClient, SqliteConfig
+
+with SqliteClient(SqliteConfig(database=":memory:")) as db:
+    db.execute("CREATE TABLE readings(equipment TEXT, temperature_c REAL)")
+    with db.transaction() as tx:
+        tx.execute("INSERT INTO readings VALUES (?, ?)", ("MILL_1", 72.5))
+    print(db.query("SELECT * FROM readings WHERE equipment=?", ("MILL_1",)))
+```
+
+Every config supports explicit constructors and `from_env()`; loading a `.env` file
+requires the `env` extra and an explicit `env_file` argument. See
+[configuration](docs/configuration.md) and the [sample environment](examples/.env.example).
+For persistent clients shared across modules, see [the sharing guide](examples/README.md).
+
+## Operational contracts
+
+- Close clients after workers stop. Context managers own cleanup; closing is terminal.
+- Use bound SQL parameters. Native placeholders differ by database; see the guides.
+- Catch `IndustrialConnectError` or its `DependencyError`, `ConnectionError` and
+  `OperationError` subclasses. Native errors remain in exception chains; cleanup
+  failures add notes instead of hiding the original failure.
+- A failed write may already have arrived. The wrapper does not retry writes; native
+  MQTT and QuestDB drivers have their own delivery/reconnect behavior.
+- MQTT/OPC UA queues are bounded. Monitor `dropped_count`; overflow means data loss.
+- Configure logging once with `setup_logging()`; modules use `get_logger(__name__)`.
+- Configure TLS, certificate trust and credentials for your deployment. Avoid logging
+  secrets and raw driver exception chains. Graylog GELF/UDP is unencrypted.
+
+See [database contracts](docs/databases.md) and [deployment and verification](docs/operations.md).
+
+## Develop and publish
+
+```shell
+python -m pip install -e ".[all,dev]"
+python manage.py check
+python manage.py build
+```
+
+The build command runs checks and creates a wheel and source archive in `dist/`.
+Uploads are explicit. See [publishing](docs/publishing.md) for version bumps,
+TestPyPI, PyPI and private registries, and [integration tests](tests/integration/README.md)
+for disposable services. Passing unit tests alone does not validate your plant's devices,
+network, database permissions or delivery requirements.
+
+Licensed under [Apache-2.0](LICENSE). SQLite defaults to `store.db`;
+`SqliteConfig.from_env()` accepts `SQLITE_DATABASE` to choose another file or `:memory:`.

industrial_connect-0.1.0/README.md

@@ -0,0 +1,83 @@
+# industrial-connect
+
+Reusable Python connectors for industrial applications. Python 3.12+, Windows and Linux.
+Optional drivers, explicit resource ownership, no import-time connections.
+
+## Install
+
+```shell
+pip install industrial-connect                    # SQLite and core
+pip install "industrial-connect[postgres,env]"
+pip install "industrial-connect[mqtt,opcua]"
+pip install "industrial-connect[all]"
+```
+
+Install only the drivers you need. Pin the tested library version and lock your
+application's dependencies. `db` includes every database; `all` includes every extra.
+
+## Connectors and runnable examples
+
+Each guide includes configuration, a realistic example, resource lifetime and error behavior.
+Run examples from the checkout; `--help` lists the available options.
+
+| Connector | Extra | Guide | Example |
+| --- | --- | --- | --- |
+| PostgreSQL | `postgres` | [PostgreSQL](docs/postgres.md) | `python -m examples.postgres` |
+| Oracle | `oracle` | [Oracle and PL/SQL](docs/oracle.md) | `python -m examples.oracle` |
+| SQL Server | `mssql` | [SQL Server](docs/mssql.md) | `python -m examples.mssql` |
+| SQLite | none | [SQLite](docs/sqlite.md) | `python -m examples.sqlite` |
+| QuestDB QWP | `questdb` | [WebSocket ingestion and SQL](docs/questdb.md) | `python -m examples.questdb` |
+| MQTT | `mqtt` | [Queue or callback telemetry](docs/mqtt.md) | `python -m examples.mqtt` / `examples.mqtt_callback` |
+| OPC UA | `opcua` | [PLC reads, writes and subscriptions](docs/opcua.md) | `python -m examples.opcua` |
+| Console/files | none | [Logging](docs/logging.md) | `python -m examples.logging_setup` |
+| Graylog | `graylog` | [GELF/UDP](docs/graylog.md) | `python -m examples.graylog` |
+
+## Quick start without a service
+
+```python
+from industrial_connect.db import SqliteClient, SqliteConfig
+
+with SqliteClient(SqliteConfig(database=":memory:")) as db:
+    db.execute("CREATE TABLE readings(equipment TEXT, temperature_c REAL)")
+    with db.transaction() as tx:
+        tx.execute("INSERT INTO readings VALUES (?, ?)", ("MILL_1", 72.5))
+    print(db.query("SELECT * FROM readings WHERE equipment=?", ("MILL_1",)))
+```
+
+Every config supports explicit constructors and `from_env()`; loading a `.env` file
+requires the `env` extra and an explicit `env_file` argument. See
+[configuration](docs/configuration.md) and the [sample environment](examples/.env.example).
+For persistent clients shared across modules, see [the sharing guide](examples/README.md).
+
+## Operational contracts
+
+- Close clients after workers stop. Context managers own cleanup; closing is terminal.
+- Use bound SQL parameters. Native placeholders differ by database; see the guides.
+- Catch `IndustrialConnectError` or its `DependencyError`, `ConnectionError` and
+  `OperationError` subclasses. Native errors remain in exception chains; cleanup
+  failures add notes instead of hiding the original failure.
+- A failed write may already have arrived. The wrapper does not retry writes; native
+  MQTT and QuestDB drivers have their own delivery/reconnect behavior.
+- MQTT/OPC UA queues are bounded. Monitor `dropped_count`; overflow means data loss.
+- Configure logging once with `setup_logging()`; modules use `get_logger(__name__)`.
+- Configure TLS, certificate trust and credentials for your deployment. Avoid logging
+  secrets and raw driver exception chains. Graylog GELF/UDP is unencrypted.
+
+See [database contracts](docs/databases.md) and [deployment and verification](docs/operations.md).
+
+## Develop and publish
+
+```shell
+python -m pip install -e ".[all,dev]"
+python manage.py check
+python manage.py build
+```
+
+The build command runs checks and creates a wheel and source archive in `dist/`.
+Uploads are explicit. See [publishing](docs/publishing.md) for version bumps,
+TestPyPI, PyPI and private registries, and [integration tests](tests/integration/README.md)
+for disposable services. Passing unit tests alone does not validate your plant's devices,
+network, database permissions or delivery requirements.
+
+Licensed under [Apache-2.0](LICENSE). SQLite defaults to `store.db`;
+`SqliteConfig.from_env()` accepts `SQLITE_DATABASE` to choose another file or `:memory:`.

industrial_connect-0.1.0/docs/configuration.md

@@ -0,0 +1,51 @@
+# Environment variables or .env files
+
+Every connector config supports `from_env()`. Direct constructors still work:
+
+```python
+from industrial_connect.db import OracleClient, OracleConfig, init_database
+from industrial_connect.mqtt import MqttClient, MqttConfig
+from industrial_connect.opcua import OpcUaClient, OpcUaConfig
+
+oracle = init_database("production", OracleClient(OracleConfig.from_env(env_file=".env")))
+mqtt = MqttClient(MqttConfig.from_env(env_file=".env"))
+opcua = OpcUaClient(OpcUaConfig.from_env(env_file=".env"))
+
+# Process variables only: no dotenv dependency required.
+config = OracleConfig.from_env()
+
+# Custom prefix for another Oracle database; explicit arguments override env/file values.
+reporting = OracleConfig.from_env(env_file=".env", prefix="REPORTING_ORACLE_", pool=True)
+
+# Plain programmatic settings remain supported.
+local = OracleConfig(dsn="localhost/service", user="app", password="example")
+```
+
+Keys are the prefix plus the **uppercase config field name**:
+
+| Config | Default prefix | Example key |
+| --- | --- | --- |
+| `OracleConfig` | `ORACLE_` | `ORACLE_DSN` |
+| `PostgresConfig` | `PG` | `PGHOST`, `PGDATABASE`, `PGPOOL` |
+| `SqlServerConfig` | `MSSQL_` | `MSSQL_SERVER` |
+| `SqliteConfig` | `SQLITE_` | `SQLITE_DATABASE` |
+| `QuestDbConfig` | `QUESTDB_` | `QUESTDB_CONF` |
+| `MqttConfig` | `MQTT_` | `MQTT_HOST`, `MQTT_CLIENT_ID`, `MQTT_USERNAME` |
+| `OpcUaConfig` | `OPCUA_` | `OPCUA_ENDPOINT`, `OPCUA_USERNAME`, `OPCUA_CERTIFICATE` |
+
+QuestDB ingestion and SQL share `QuestDbConfig.from_env(env_file=".env")`;
+set `QUESTDB_CONF` to a `wss::` connection string (`ws::` for explicit local plaintext).
+
+Precedence is explicit arguments, process environment, .env values, then config defaults.
+Numbers and booleans are parsed (`true/false`, `1/0`, `yes/no`, `on/off`, case-insensitive).
+Empty optional values become `None`; required string values remain strings. Missing
+required fields and invalid values raise errors identifying variable names without values.
+The usual config validation still applies. No .env discovery or `os.environ` mutation occurs;
+python-dotenv handles file quoting and interpolation. Reading an explicitly supplied file
+requires the `env` extra, also included in `all`.
+
+See [the sample file](../examples/.env.example). A service-free example is runnable with:
+
+```shell
+python -m examples.env_config --env-file examples/.env.example
+```

industrial_connect-0.1.0/docs/databases.md

@@ -0,0 +1,89 @@
+# Relational databases
+
+```python
+from industrial_connect.db import SqliteClient, SqliteConfig
+
+with SqliteClient(SqliteConfig(database=":memory:")) as db:
+    db.execute("create table readings (value real)")
+    with db.transaction() as tx:
+        tx.execute("insert into readings values (?)", (1.5,))
+        tx.executemany("insert into readings values (?)", [(2.5,), (3.5,)])
+    print(db.query("select * from readings where value > ?", (2.0,)))
+```
+
+`PostgresClient(PostgresConfig(...))`, `OracleClient(OracleConfig(...))`, and
+`SqlServerClient(SqlServerConfig(...))` expose the same basic methods. All configuration
+classes are frozen dataclasses with keyword-only parameters. Passwords are excluded from
+their representations. Constructors validate without connecting. Database context entry
+does not connect; the first operation does. `close()` is idempotent and terminal.
+
+`query(sql, params=None)` returns dictionary rows. Column names retain driver casing;
+use distinct aliases when selecting duplicate column names. `execute()` and `executemany()`
+return native affected-row counts, including `-1` when the driver cannot determine one.
+Keep native parameter binding: PostgreSQL/SQL Server `%s` or named `%(name)s`, Oracle
+`:name`, SQLite `?` or `:name`. Never interpolate user values or identifiers into SQL.
+
+Standalone operations commit on success and roll back on failure. `transaction()` yields
+a session bound to one connection, commits on successful exit, and rolls back when an
+exception escapes the block. Catch operation errors outside that block when all-or-nothing
+behavior is required. A session is invalid after exit. Database DDL follows native behavior:
+Oracle DDL implicitly commits and cannot be made transactional by this wrapper.
+
+Failures raise `ConnectionError` or `OperationError`, with the driver exception in
+`__cause__`. Empty query results mean a successful query with zero rows. A failed commit
+can have an uncertain outcome; do not retry writes blindly. No SQL operations are retried.
+Wrapper error text excludes SQL, bind values and credentials; driver exception chains and
+application log messages can still contain sensitive data.
+
+### Connection ownership
+
+- PostgreSQL opens per-operation connections by default. Set `pool=True` for a native
+  Psycopg pool, created on first use. Pool bounds and acquisition timeout are configurable;
+  exhaustion raises an error. Returned connections commit or roll back before reuse.
+- Oracle opens per-operation connections by default; `pool=True` uses its native pool with
+  a timed acquisition. Thin mode is the default. Call `init_oracle_thick(lib_dir=...)`
+  explicitly before any Oracle connections to use installed Oracle Client libraries.
+  Thick/Thin selection is process-wide; old servers may require Thick mode.
+- SQL Server opens per-operation connections; no custom pooling. Its encryption setting
+  defaults to `require`. Certificate verification and trust settings are controlled by
+  FreeTDS configuration; encryption alone is not a certificate trust policy. Native
+  pymssql/FreeTDS timeout settings can affect the process; prefer consistent timeouts.
+- SQLite retains one lazy connection, including for `:memory:`, and serializes operations
+  across calling threads. Nested transactions are rejected; use the active session.
+
+Share a client instance, not a session or cursor, between application modules. The optional
+named registry provides `init_database(name, client)`, `get_database(name)`,
+`close_database(name)`, and `close_all_databases()`, all importable from `industrial_connect.db`.
+For example, `oracle = init_database("production", OracleClient(config))` returns that
+same client; any file can call `get_database("production").query(...)` without passing
+objects through handlers. See the [named database examples](../examples/README.md).
+Close registered clients through the registry after workers finish. Ordinary unregistered
+clients can still be used independently. Do not share clients across processes or close pooled clients while
+operations are in flight. PostgreSQL defaults to `sslmode="verify-full"`; configure
+`sslrootcert` for your CA. Plaintext connections require explicit configuration.
+Oracle accepts native TCPS/wallet options in its DSN; configure them for your deployment.
+
+### Oracle PL/SQL
+
+```python
+# client is an OracleClient configured by the application
+import oracledb
+
+with client.transaction() as tx:
+    result = tx.call(
+        "begin :total := :input + 1; open :rows for select :input as value from dual; end;",
+        {"input": 41},
+        {"total": oracledb.DB_TYPE_NUMBER, "rows": oracledb.DB_TYPE_CURSOR},
+    )
+    print(result.out_binds, result.cursors, result.implicit_results)
+```
+
+Output types accept native constants (`oracledb.DB_TYPE_NUMBER`, `oracledb.DB_TYPE_VARCHAR`,
+`oracledb.DB_TYPE_CURSOR`, etc.), Python types (`int`, `str`, etc.), and legacy string names.
+Type hints cover native Oracle types and Oracle transaction sessions. Shared database
+methods expose `QueryParams`, `Row`, affected-row counts, and typed context-manager results.
+Optional drivers are imported for type checking only until a connection is used.
+Output REF CURSORs and
+implicit results are fully fetched before cursor cleanup. Client-level `call()` commits
+on success; session-level `call()` participates in its surrounding transaction. There is
+no detached `commit()` method that might accidentally use another connection.

industrial_connect-0.1.0/docs/graylog.md

@@ -0,0 +1,25 @@
+# Graylog
+
+Install `industrial-connect[graylog]`. Configure an approved Graylog GELF/UDP input:
+
+```shell
+python -m examples.graylog --host graylog.internal --port 12201
+```
+
+Alternatively set `GRAYLOG_HOST` and `GRAYLOG_PORT`. [The example](../examples/graylog.py)
+adds structured `equipment_id` and `temperature_c` fields, retains console output,
+and closes the handlers it owns at shutdown. This only sends an event; it cannot
+confirm that Graylog received or indexed it.
+
+`setup_logging("collector", graylog_host=..., graylog_port=...)` uses graypy's
+GELF/UDP handler. UDP provides neither delivery acknowledgements nor TLS. Use an
+appropriate protected network, and use your existing log shipping infrastructure
+when authenticated encrypted or durable delivery is required. No credentials, raw
+connection configurations or driver exception chains belong in log messages.
+
+Configure the outputs once at startup and use `get_logger(__name__)` in every
+module. Read [logging configuration and ownership](logging.md). The helper attaches
+its handlers to the root logger, preserving handlers installed by other code. Console
+and file output stay readable text; the Graylog handler produces GELF JSON with
+`app_name` as the facility and structured `extra` fields. Call `shutdown_logging()`
+after application workers stop to close only the helper's outputs.