attune-sdk 0.1.0__tar.gz

attune_sdk-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,68 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/attune-sdk
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  test-publish:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event.release.prerelease
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/attune-sdk
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

attune_sdk-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/

attune_sdk-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 David Culbreth
+
+   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.

attune_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: attune-sdk
+Version: 0.1.0
+Summary: Python SDK for building Attune actions and sensors
+Project-URL: Homepage, https://github.com/attune-system/python-attune-sdk
+Project-URL: Repository, https://github.com/attune-system/python-attune-sdk
+Project-URL: Issues, https://github.com/attune-system/python-attune-sdk/issues
+Author-email: David Culbreth <david.culbreth.256@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: attune,automation,orchestration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Requires-Dist: attrs>=21.3.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: python-json-logger>=3.0
+Provides-Extra: dev
+Requires-Dist: openapi-python-client>=0.28; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Provides-Extra: sensor
+Requires-Dist: pika>=1.3; extra == 'sensor'
+Description-Content-Type: text/markdown
+
+# attune — Python SDK for Attune Actions & Sensors
+
+A lightweight Python package providing boilerplate for writing [Attune](https://github.com/attune-system/attune) actions and sensors.
+
+## Installation
+
+```bash
+pip install attune-sdk              # includes API client, httpx, attrs
+pip install attune-sdk[sensor]      # adds pika for MQ-based sensors
+pip install attune-sdk[dev]         # adds pytest + openapi-python-client
+```
+
+## Writing Actions
+
+Actions receive parameters as JSON on stdin and output results as JSON on stdout.
+This package handles all of that:
+
+```python
+#!/usr/bin/env python3
+import attune
+
+def main(name: str, count: int = 1):
+    return {"greeting": f"Hello, {name}!" * count}
+
+attune.run_action(main)
+```
+
+Your function declares whatever parameters it needs as keyword arguments —
+they're matched from the JSON input. Extra parameters not in your signature
+are silently dropped (unless you add `**kwargs`).
+
+### Accessing Execution Context
+
+The context is a module-level singleton available anywhere after import:
+
+```python
+import attune
+
+def main(url: str, method: str = "GET"):
+    if attune.context.has_api_token:
+        from attune.api_client.api.packs import list_packs
+        packs = list_packs.sync(client=attune.context.client)
+        # ...
+    return {"action": attune.context.action_ref, "exec_id": attune.context.execution_id}
+
+attune.run_action(main)
+```
+
+### Using the API Client
+
+The SDK includes a fully typed, auto-generated OpenAPI client. The easiest way
+to use it is via `attune.context.client` which is a lazily constructed
+`AuthenticatedClient` using the execution-scoped token:
+
+```python
+import attune
+from attune.api_client.api.packs import list_packs
+from attune.api_client.api.executions import get_execution
+
+# Sync — use endpoint_name.sync(client=...)
+packs = list_packs.sync(client=attune.context.client)
+
+# Async — use endpoint_name.asyncio(client=...) with the same client instance
+packs = await list_packs.asyncio(client=attune.context.client)
+```
+
+The same client instance handles both sync and async calls — no separate
+async client needed. Each endpoint module exposes four functions:
+
+| Function | Returns |
+|----------|---------|
+| `sync(client=...)` | Parsed response model (or `None`) |
+| `sync_detailed(client=...)` | `Response[T]` with status, headers, content |
+| `asyncio(client=...)` | Parsed response model (async) |
+| `asyncio_detailed(client=...)` | `Response[T]` (async) |
+
+**Constructing a client manually** (e.g., outside an execution):
+
+```python
+from attune.api_client import AuthenticatedClient
+client = AuthenticatedClient(base_url="http://localhost:8080", token="your-token")
+```
+
+All API modules live under `attune.api_client.api.<domain>` and all request/response
+models under `attune.api_client.models`.
+
+## Writing Sensors
+
+Sensors are long-running processes that emit events. The SDK provides rule
+lifecycle management, signal handling (SIGINT/SIGTERM), and MQ integration
+out of the box.
+
+The sensor context is a module-level singleton, accessible anywhere:
+
+```python
+import attune
+
+# attune.sensor_context is available at import time
+print(attune.sensor_context.sensor_ref)
+print(attune.sensor_context.api_url)
+print(attune.sensor_context.config)  # ATTUNE_SENSOR_CONFIG_* vars
+```
+
+### Synchronous Polling (`PollingSensor`)
+
+One polling thread per active rule:
+
+```python
+#!/usr/bin/env python3
+import attune
+
+class TemperatureSensor(attune.PollingSensor):
+    def setup(self):
+        self.interval = 5.0  # default interval (overridable per-rule)
+
+    def poll(self, rule):
+        device = rule.trigger_params.get("device", "/dev/temp0")
+        temp = read_temperature(device)
+        if temp > 100:
+            self.emit({"temperature": temp, "alert": True}, rule=rule)
+
+attune.run_sensor(TemperatureSensor)
+```
+
+### Async Polling (`AsyncPollingSensor`)
+
+One asyncio task per active rule (ideal for I/O-bound checks):
+
+```python
+#!/usr/bin/env python3
+import attune
+
+class ApiSensor(attune.AsyncPollingSensor):
+    async def setup(self):
+        import httpx
+        self.http = httpx.AsyncClient()
+        self.interval = 10.0
+
+    async def poll(self, rule):
+        url = rule.trigger_params["url"]
+        resp = await self.http.get(url)
+        if resp.status_code >= 500:
+            self.emit({"url": url, "status": resp.status_code}, rule=rule)
+
+    async def cleanup(self):
+        await self.http.aclose()
+
+attune.run_sensor(ApiSensor)
+```
+
+### Custom Event Loops (`Sensor` base class)
+
+For non-polling sensors, override `run()`:
+
+```python
+import attune
+
+class FileTailSensor(attune.Sensor):
+    def run(self):
+        import time
+        path = attune.sensor_context.config.get("watch_path", "/var/log/app.log")
+        with open(path) as f:
+            f.seek(0, 2)  # seek to end
+            while not self.is_shutting_down:
+                line = f.readline()
+                if line:
+                    self.emit({"line": line.strip()})
+                else:
+                    time.sleep(0.5)
+
+attune.run_sensor(FileTailSensor)
+```
+
+### Rule Lifecycle Hooks
+
+All sensor classes support rule lifecycle hooks that fire when the platform
+creates, enables, disables, deletes, or updates a rule:
+
+```python
+class StatefulSensor(attune.PollingSensor):
+    def on_rule_created(self, rule):
+        """New rule activated — allocate per-rule resources."""
+        self.logger.info("Rule created: %s", rule.rule_ref, extra={"params": rule.trigger_params})
+
+    def on_rule_enabled(self, rule):
+        """Previously disabled rule re-enabled."""
+
+    def on_rule_disabled(self, rule):
+        """Rule disabled — pause per-rule work."""
+
+    def on_rule_deleted(self, rule):
+        """Rule permanently removed — free resources."""
+
+    def on_rule_updated(self, rule, old_params):
+        """Rule parameters changed — adapt."""
+        self.logger.info("Rule updated: %s → %s", old_params, rule.trigger_params)
+```
+
+`PollingSensor` and `AsyncPollingSensor` automatically start/stop per-rule
+poll threads/tasks in response to these hooks. Override them to add custom
+behavior (call `super()` to keep the auto-management).
+
+## Environment Variables
+
+### Actions
+
+| Variable | Description |
+|----------|-------------|
+| `ATTUNE_ACTION` | Action reference (e.g., `mypack.deploy`) |
+| `ATTUNE_PACK_REF` | Pack reference |
+| `ATTUNE_EXEC_ID` | Execution database ID |
+| `ATTUNE_API_URL` | API base URL |
+| `ATTUNE_API_TOKEN` | Execution-scoped API token (optional) |
+| `ATTUNE_ARTIFACTS_DIR` | Shared artifact volume path |
+| `ATTUNE_RULE` | Rule reference (if rule-triggered) |
+| `ATTUNE_TRIGGER` | Trigger reference (if event-triggered) |
+
+### Sensors
+
+| Variable | Description |
+|----------|-------------|
+| `ATTUNE_SENSOR_REF` | Sensor reference |
+| `ATTUNE_SENSOR_ID` | Sensor database ID |
+| `ATTUNE_API_URL` | API base URL |
+| `ATTUNE_API_TOKEN` | Sensor-scoped API token |
+| `ATTUNE_MQ_URL` | RabbitMQ connection URL |
+| `ATTUNE_MQ_EXCHANGE` | RabbitMQ exchange name |
+| `ATTUNE_LOG_LEVEL` | Log verbosity |
+
+## Development
+
+```bash
+cd packs.external/python-attune
+pip install -e ".[dev]"
+pytest
+```
+
+### Regenerating the API Client
+
+The generated client is committed to the repo so users get it out of the box.
+To update it after API changes:
+
+```bash
+# With a running API:
+./scripts/generate-client.sh
+
+# Or from a spec file:
+./scripts/generate-client.sh /path/to/openapi.json
+```
+
+Requires `openapi-python-client` (included in `[dev]` extras).