plexus-agent 0.3.2__tar.gz

plexus_agent-0.3.2/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (leave empty for current)'
+        required: false
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses trusted publishing - configure at pypi.org/manage/project/plexus-agent/settings/publishing/

plexus_agent-0.3.2/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check .
+
+      - name: Run tests
+        run: pytest -v

plexus_agent-0.3.2/.gitignore

@@ -0,0 +1,54 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.ruff_cache/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Type checking
+.mypy_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Local config
+.env
+.env.local

plexus_agent-0.3.2/API.md

@@ -0,0 +1,367 @@
+# Plexus HTTP API
+
+Send telemetry data to Plexus using any HTTP client. No SDK required.
+
+## Quick Start
+
+```bash
+curl -X POST https://app.plexus.company/api/ingest \
+  -H "x-api-key: YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "points": [{
+      "metric": "temperature",
+      "value": 72.5,
+      "timestamp": 1699900000,
+      "device_id": "sensor-001"
+    }]
+  }'
+```
+
+## Getting an API Key
+
+**Plexus Cloud:**
+
+1. Sign up at [app.plexus.company](https://app.plexus.company)
+2. Go to Settings → Connections
+3. Create an API key (starts with `plx_`)
+
+## Endpoints
+
+| Endpoint        | Method | Description                  |
+| --------------- | ------ | ---------------------------- |
+| `/api/ingest`   | POST   | Send telemetry data          |
+| `/api/sessions` | POST   | Start/end recording sessions |
+
+## Authentication
+
+All requests require an API key in the header:
+
+```
+x-api-key: plx_xxxxx
+```
+
+## Send Data
+
+**POST** `/api/ingest`
+
+```json
+{
+  "points": [
+    {
+      "metric": "temperature",
+      "value": 72.5,
+      "timestamp": 1699900000.123,
+      "device_id": "sensor-001",
+      "tags": { "location": "lab" },
+      "session_id": "test-001"
+    }
+  ]
+}
+```
+
+| Field        | Type   | Required | Description                                    |
+| ------------ | ------ | -------- | ---------------------------------------------- |
+| `metric`     | string | Yes      | Metric name (e.g., `temperature`, `motor.rpm`) |
+| `value`      | any    | Yes      | See supported value types below                |
+| `timestamp`  | float  | No       | Unix timestamp (seconds). Defaults to now      |
+| `device_id`  | string | Yes      | Your device identifier                         |
+| `tags`       | object | No       | Key-value labels                               |
+| `session_id` | string | No       | Group data into sessions                       |
+
+### Supported Value Types
+
+Plexus accepts multiple value types to support diverse sensor data:
+
+| Type    | Example                           | Use Case                          |
+| ------- | --------------------------------- | --------------------------------- |
+| number  | `72.5`, `-40`, `3.14159`          | Numeric readings (most common)    |
+| string  | `"error"`, `"idle"`, `"running"`  | Status, state, labels             |
+| boolean | `true`, `false`                   | On/off, enabled/disabled          |
+| object  | `{"x": 1.2, "y": 3.4, "z": 5.6}`  | Vector data, structured readings  |
+| array   | `[1.0, 2.0, 3.0, 4.0]`            | Waveforms, multiple values        |
+
+```json
+{
+  "points": [
+    { "metric": "temperature", "value": 72.5, "device_id": "pi-001" },
+    { "metric": "motor_state", "value": "running", "device_id": "pi-001" },
+    { "metric": "armed", "value": true, "device_id": "pi-001" },
+    { "metric": "accel", "value": {"x": 0.1, "y": 0.2, "z": 9.8}, "device_id": "pi-001" },
+    { "metric": "fft_bins", "value": [0.1, 0.5, 0.8, 0.3], "device_id": "pi-001" }
+  ]
+}
+```
+
+**Response:** `200 OK` on success
+
+## Sessions
+
+Group related data for analysis and playback.
+
+**Start session:**
+
+```json
+POST /api/sessions
+{
+  "session_id": "test-001",
+  "device_id": "sensor-001",
+  "status": "started",
+  "timestamp": 1699900000
+}
+```
+
+**End session:**
+
+```json
+POST /api/sessions
+{
+  "session_id": "test-001",
+  "device_id": "sensor-001",
+  "status": "ended",
+  "timestamp": 1699903600
+}
+```
+
+## Examples
+
+### Bash
+
+```bash
+#!/bin/bash
+API_KEY="plx_xxxxx"
+DEVICE_ID="sensor-001"
+
+curl -X POST https://app.plexus.company/api/ingest \
+  -H "x-api-key: $API_KEY" \
+  -H "Content-Type: application/json" \
+  -d "{
+    \"points\": [{
+      \"metric\": \"temperature\",
+      \"value\": 72.5,
+      \"timestamp\": $(date +%s),
+      \"device_id\": \"$DEVICE_ID\"
+    }]
+  }"
+```
+
+### JavaScript
+
+```javascript
+const API_KEY = "plx_xxxxx";
+const DEVICE_ID = "sensor-001";
+
+await fetch("https://app.plexus.company/api/ingest", {
+  method: "POST",
+  headers: {
+    "x-api-key": API_KEY,
+    "Content-Type": "application/json",
+  },
+  body: JSON.stringify({
+    points: [
+      {
+        metric: "temperature",
+        value: 72.5,
+        timestamp: Date.now() / 1000,
+        device_id: DEVICE_ID,
+      },
+    ],
+  }),
+});
+```
+
+### Go
+
+```go
+package main
+
+import (
+    "bytes"
+    "encoding/json"
+    "net/http"
+    "time"
+)
+
+func main() {
+    points := map[string]interface{}{
+        "points": []map[string]interface{}{{
+            "metric":    "temperature",
+            "value":     72.5,
+            "timestamp": float64(time.Now().Unix()),
+            "device_id": "sensor-001",
+        }},
+    }
+
+    body, _ := json.Marshal(points)
+    req, _ := http.NewRequest("POST", "https://app.plexus.company/api/ingest", bytes.NewBuffer(body))
+    req.Header.Set("x-api-key", "plx_xxxxx")
+    req.Header.Set("Content-Type", "application/json")
+
+    http.DefaultClient.Do(req)
+}
+```
+
+### Python (no SDK)
+
+```python
+import requests
+import time
+
+requests.post(
+    "https://app.plexus.company/api/ingest",
+    headers={"x-api-key": "plx_xxxxx"},
+    json={
+        "points": [{
+            "metric": "temperature",
+            "value": 72.5,
+            "timestamp": time.time(),
+            "device_id": "sensor-001"
+        }]
+    }
+)
+```
+
+### Arduino / ESP32
+
+```cpp
+#include <WiFi.h>
+#include <HTTPClient.h>
+
+void sendToPlexus(const char* metric, float value) {
+    HTTPClient http;
+    http.begin("https://app.plexus.company/api/ingest");
+    http.addHeader("Content-Type", "application/json");
+    http.addHeader("x-api-key", "plx_xxxxx");
+
+    String payload = "{\"points\":[{";
+    payload += "\"metric\":\"" + String(metric) + "\",";
+    payload += "\"value\":" + String(value) + ",";
+    payload += "\"timestamp\":" + String(millis() / 1000.0) + ",";
+    payload += "\"device_id\":\"esp32-001\"";
+    payload += "}]}";
+
+    http.POST(payload);
+    http.end();
+}
+```
+
+## Self-Hosted
+
+For self-hosted instances, replace the endpoint:
+
+```bash
+curl -X POST http://your-server:3000/api/ingest \
+  -H "x-api-key: plx_selfhost_default_key_12345678" \
+  ...
+```
+
+## Errors
+
+| Status | Meaning                         |
+| ------ | ------------------------------- |
+| 200    | Success                         |
+| 400    | Bad request (check JSON format) |
+| 401    | Invalid or missing API key      |
+| 403    | API key lacks permissions       |
+
+## Best Practices
+
+- **Batch points** - Send up to 100 points per request
+- **Use timestamps** - Always include accurate timestamps
+- **Consistent device_id** - Use the same ID for each physical device
+- **Use tags** - Label data for filtering (e.g., `{"location": "lab", "unit": "celsius"}`)
+
+## Python SDK with Sensor Drivers
+
+The Python SDK includes pre-built drivers for common sensors. Zero configuration required.
+
+### Quick Start (Raspberry Pi)
+
+```bash
+pip install plexus-agent[sensors]
+plexus login
+plexus run  # Auto-detects and streams all connected sensors
+```
+
+### Supported Sensors
+
+| Sensor  | Type        | Metrics                                              | I2C Address |
+| ------- | ----------- | ---------------------------------------------------- | ----------- |
+| MPU6050 | 6-axis IMU  | `accel_x`, `accel_y`, `accel_z`, `gyro_x`, `gyro_y`, `gyro_z` | 0x68, 0x69 |
+| MPU9250 | 9-axis IMU  | `accel_x`, `accel_y`, `accel_z`, `gyro_x`, `gyro_y`, `gyro_z` | 0x68       |
+| BME280  | Environment | `temperature`, `humidity`, `pressure`                | 0x76, 0x77 |
+
+### CLI Commands
+
+```bash
+plexus sensors        # List all supported sensors and their metrics
+plexus scan           # Detect sensors connected to your device
+plexus run            # Stream all detected sensors to Plexus
+plexus run --rate 50  # Override sample rate (Hz)
+```
+
+### Python API
+
+```python
+from plexus import Plexus
+from plexus.sensors import SensorHub, MPU6050, BME280
+
+# Manual setup
+hub = SensorHub()
+hub.add(MPU6050(sample_rate=100))  # 100 Hz for IMU
+hub.add(BME280(sample_rate=1))     # 1 Hz for environmental
+hub.run(Plexus())
+```
+
+### Auto-Detection
+
+```python
+from plexus import Plexus
+from plexus.sensors import auto_sensors
+
+hub = auto_sensors()  # Scans I2C bus, creates drivers
+hub.run(Plexus())     # Streams everything
+```
+
+### Custom Sensors
+
+Extend `BaseSensor` to add your own:
+
+```python
+from plexus.sensors import BaseSensor, SensorReading
+
+class MySensor(BaseSensor):
+    name = "MySensor"
+    metrics = ["voltage", "current"]
+
+    def read(self):
+        return [
+            SensorReading("voltage", read_adc(0) * 3.3),
+            SensorReading("current", read_adc(1) * 0.1),
+        ]
+
+hub = SensorHub()
+hub.add(MySensor(sample_rate=10))
+hub.run(Plexus())
+```
+
+## Why use the Python SDK?
+
+The SDK adds convenience but isn't required:
+
+| Feature        | Raw HTTP         | Python SDK              |
+| -------------- | ---------------- | ----------------------- |
+| Send data      | Manual JSON      | `px.send("temp", 72.5)` |
+| Sessions       | Manual start/end | `with px.session():`    |
+| Auth setup     | Manual header    | `plexus login`          |
+| Batching       | Manual           | `px.send_batch([...])`  |
+| MQTT bridge    | Not available    | `plexus mqtt-bridge`    |
+| Sensor drivers | Not available    | `plexus run`            |
+| Auto-detect    | Not available    | `plexus scan`           |
+
+Use raw HTTP when:
+
+- You're not using Python
+- You want minimal dependencies
+- You're on embedded devices (Arduino, ESP32)
+- You're building your own client library

plexus_agent-0.3.2/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 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
+
+   Copyright 2024 Plexus
+
+   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.