plexus-agent 0.1.0__tar.gz

plexus_agent-0.1.0/.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.1.0/.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.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# 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.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 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.

plexus_agent-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: plexus-agent
+Version: 0.1.0
+Summary: Send sensor data to Plexus in one line of code
+Project-URL: Homepage, https://plexus.dev
+Project-URL: Documentation, https://docs.plexus.dev
+Project-URL: Repository, https://github.com/plexus-oss/agent
+Project-URL: Issues, https://github.com/plexus-oss/agent/issues
+Author-email: Plexus <hello@plexus.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: hardware,iot,observability,robotics,sensors,telemetry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.8
+Requires-Dist: click>=8.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt>=1.6.0; extra == 'mqtt'
+Description-Content-Type: text/markdown
+
+# Plexus Agent
+
+> Send sensor data to Plexus in one line of code.
+
+## Quick Start
+
+```bash
+pip install plexus-agent
+plexus init        # paste your API key from app.plexusaero.space
+plexus send temperature 72.5
+```
+
+That's it. Works on any device with Python - Raspberry Pi, servers, laptops, containers.
+
+## Get Your API Key
+
+1. Go to [app.plexusaero.space/settings](https://app.plexusaero.space/settings?tab=connections)
+2. Create an API key
+3. Copy the key and paste it when running `plexus init`
+
+## Sending Data
+
+### Command Line
+
+```bash
+# Basic
+plexus send temperature 72.5
+
+# With tags (for multiple sensors)
+plexus send motor.temperature 72.5 -t motor_id=A1
+plexus send motor.temperature 68.3 -t motor_id=A2
+
+# Stream from any script
+python read_sensor.py | plexus stream temperature
+```
+
+### Python SDK
+
+```python
+from plexus import Plexus
+
+px = Plexus()
+
+# Send values
+px.send("temperature", 72.5)
+px.send("motor.rpm", 3450, tags={"motor_id": "A1"})
+
+# Batch send (more efficient)
+px.send_batch([
+    ("temperature", 72.5),
+    ("humidity", 45.2),
+    ("pressure", 1013.25),
+])
+```
+
+### Session Recording
+
+Group related data for easy analysis:
+
+```python
+from plexus import Plexus
+
+px = Plexus()
+
+with px.session("motor-test-001"):
+    for _ in range(1000):
+        px.send("temperature", read_temp())
+        px.send("rpm", read_rpm())
+        time.sleep(0.01)  # 100Hz
+```
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `plexus init` | Set up API key |
+| `plexus send <metric> <value>` | Send a single value |
+| `plexus stream <metric>` | Stream from stdin |
+| `plexus status` | Check connection |
+
+### Examples
+
+```bash
+# Send with tags
+plexus send motor.rpm 3450 -t motor_id=A1 -t location=lab
+
+# Send with timestamp
+plexus send pressure 1013.25 --timestamp 1699900000
+
+# Stream with rate limiting
+cat data.txt | plexus stream pressure -r 100
+
+# Stream with session
+python read_motor.py | plexus stream motor.rpm -s test-001
+```
+
+## Configuration
+
+Config is stored in `~/.plexus/config.json`.
+
+### Environment Variables
+
+Override config with environment variables:
+
+```bash
+export PLEXUS_API_KEY=plx_xxxxx
+export PLEXUS_ENDPOINT=https://plexus.yourcompany.com  # for self-hosted
+```
+
+## Examples
+
+### Raspberry Pi + DHT22
+
+```python
+from plexus import Plexus
+import adafruit_dht
+import board
+import time
+
+px = Plexus()
+dht = adafruit_dht.DHT22(board.D4)
+
+while True:
+    try:
+        px.send("temperature", dht.temperature)
+        px.send("humidity", dht.humidity)
+    except RuntimeError:
+        pass
+    time.sleep(2)
+```
+
+### Arduino Serial Bridge
+
+```python
+from plexus import Plexus
+import serial
+
+px = Plexus()
+ser = serial.Serial('/dev/ttyUSB0', 9600)
+
+while True:
+    line = ser.readline().decode().strip()
+    if ':' in line:
+        metric, value = line.split(':')
+        px.send(metric, float(value))
+```
+
+### Motor Test Stand
+
+```python
+from plexus import Plexus
+import time
+
+px = Plexus()
+
+with px.session("endurance-test-001"):
+    start = time.time()
+    while time.time() - start < 3600:  # 1 hour
+        px.send_batch([
+            ("motor.rpm", read_rpm()),
+            ("motor.current", read_current()),
+            ("motor.temperature", read_temp()),
+        ])
+        time.sleep(0.01)  # 100Hz
+```
+
+## License
+
+Apache-2.0

plexus_agent-0.1.0/README.md

@@ -0,0 +1,169 @@
+# Plexus Agent
+
+> Send sensor data to Plexus in one line of code.
+
+## Quick Start
+
+```bash
+pip install plexus-agent
+plexus init        # paste your API key from app.plexusaero.space
+plexus send temperature 72.5
+```
+
+That's it. Works on any device with Python - Raspberry Pi, servers, laptops, containers.
+
+## Get Your API Key
+
+1. Go to [app.plexusaero.space/settings](https://app.plexusaero.space/settings?tab=connections)
+2. Create an API key
+3. Copy the key and paste it when running `plexus init`
+
+## Sending Data
+
+### Command Line
+
+```bash
+# Basic
+plexus send temperature 72.5
+
+# With tags (for multiple sensors)
+plexus send motor.temperature 72.5 -t motor_id=A1
+plexus send motor.temperature 68.3 -t motor_id=A2
+
+# Stream from any script
+python read_sensor.py | plexus stream temperature
+```
+
+### Python SDK
+
+```python
+from plexus import Plexus
+
+px = Plexus()
+
+# Send values
+px.send("temperature", 72.5)
+px.send("motor.rpm", 3450, tags={"motor_id": "A1"})
+
+# Batch send (more efficient)
+px.send_batch([
+    ("temperature", 72.5),
+    ("humidity", 45.2),
+    ("pressure", 1013.25),
+])
+```
+
+### Session Recording
+
+Group related data for easy analysis:
+
+```python
+from plexus import Plexus
+
+px = Plexus()
+
+with px.session("motor-test-001"):
+    for _ in range(1000):
+        px.send("temperature", read_temp())
+        px.send("rpm", read_rpm())
+        time.sleep(0.01)  # 100Hz
+```
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `plexus init` | Set up API key |
+| `plexus send <metric> <value>` | Send a single value |
+| `plexus stream <metric>` | Stream from stdin |
+| `plexus status` | Check connection |
+
+### Examples
+
+```bash
+# Send with tags
+plexus send motor.rpm 3450 -t motor_id=A1 -t location=lab
+
+# Send with timestamp
+plexus send pressure 1013.25 --timestamp 1699900000
+
+# Stream with rate limiting
+cat data.txt | plexus stream pressure -r 100
+
+# Stream with session
+python read_motor.py | plexus stream motor.rpm -s test-001
+```
+
+## Configuration
+
+Config is stored in `~/.plexus/config.json`.
+
+### Environment Variables
+
+Override config with environment variables:
+
+```bash
+export PLEXUS_API_KEY=plx_xxxxx
+export PLEXUS_ENDPOINT=https://plexus.yourcompany.com  # for self-hosted
+```
+
+## Examples
+
+### Raspberry Pi + DHT22
+
+```python
+from plexus import Plexus
+import adafruit_dht
+import board
+import time
+
+px = Plexus()
+dht = adafruit_dht.DHT22(board.D4)
+
+while True:
+    try:
+        px.send("temperature", dht.temperature)
+        px.send("humidity", dht.humidity)
+    except RuntimeError:
+        pass
+    time.sleep(2)
+```
+
+### Arduino Serial Bridge
+
+```python
+from plexus import Plexus
+import serial
+
+px = Plexus()
+ser = serial.Serial('/dev/ttyUSB0', 9600)
+
+while True:
+    line = ser.readline().decode().strip()
+    if ':' in line:
+        metric, value = line.split(':')
+        px.send(metric, float(value))
+```
+
+### Motor Test Stand
+
+```python
+from plexus import Plexus
+import time
+
+px = Plexus()
+
+with px.session("endurance-test-001"):
+    start = time.time()
+    while time.time() - start < 3600:  # 1 hour
+        px.send_batch([
+            ("motor.rpm", read_rpm()),
+            ("motor.current", read_current()),
+            ("motor.temperature", read_temp()),
+        ])
+        time.sleep(0.01)  # 100Hz
+```
+
+## License
+
+Apache-2.0

plexus_agent-0.1.0/plexus/__init__.py

@@ -0,0 +1,15 @@
+"""
+Plexus Agent - Send sensor data to Plexus in one line of code.
+
+Usage:
+    from plexus import Plexus
+
+    px = Plexus()
+    px.send("temperature", 72.5)
+"""
+
+from plexus.client import Plexus
+from plexus.config import load_config, save_config
+
+__version__ = "0.1.0"
+__all__ = ["Plexus", "load_config", "save_config"]