plexus-python 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

plexus/__init__.py

@@ -1,31 +1,13 @@
 """
-Plexus Agent - Send sensor data to Plexus in one line of code.
+Plexus — thin Python SDK for sending telemetry to the Plexus gateway.
 
-Basic Usage:
     from plexus import Plexus
 
-    px = Plexus()
+    px = Plexus(api_key="plx_xxx", source_id="device-001")
     px.send("temperature", 72.5)
-
-With Sensors (pip install plexus-python[sensors]):
-    from plexus import Plexus
-    from plexus.sensors import SensorHub, MPU6050, BME280
-
-    hub = SensorHub()
-    hub.add(MPU6050(sample_rate=100))
-    hub.add(BME280(sample_rate=1))
-    hub.run(Plexus())
-
-Auto-Detection:
-    from plexus import Plexus
-    from plexus.sensors import auto_sensors
-
-    hub = auto_sensors()  # Finds all connected sensors
-    hub.run(Plexus())
 """
 
 from plexus.client import Plexus
-from plexus.config import load_config, save_config
 
-__version__ = "0.1.0"
-__all__ = ["Plexus", "load_config", "save_config"]
+__version__ = "0.2.0"
+__all__ = ["Plexus"]

plexus/client.py

@@ -49,7 +49,6 @@ from plexus.config import (
     get_endpoint,
     get_gateway_url,
     get_source_id,
-    require_login,
 )
 logger = logging.getLogger(__name__)
 
@@ -98,10 +97,11 @@ class Plexus:
         buffer_path: Optional[str] = None,
     ):
         self.api_key = api_key or get_api_key()
-
-        # Require login if no API key provided
         if not self.api_key:
-            require_login()
+            raise ValueError(
+                "No API key. Pass api_key=... or set PLEXUS_API_KEY. "
+                "Get a key at app.plexus.company/devices."
+            )
 
         self.endpoint = (endpoint or get_endpoint()).rstrip("/")
         self.gateway_url = get_gateway_url()

plexus/config.py

@@ -50,15 +50,12 @@ CONFIG_FILE = CONFIG_DIR / "config.json"
 
 PLEXUS_ENDPOINT = "https://app.plexus.company"
 PLEXUS_GATEWAY_URL = "https://plexus-gateway.fly.dev"
+PLEXUS_GATEWAY_WS_URL = "wss://plexus-gateway.fly.dev"
 
 DEFAULT_CONFIG = {
     "api_key": None,
     "source_id": None,
-    "org_id": None,
-    "source_name": None,
-    "endpoint": None,
     "persistent_buffer": True,
-    "sensors": None,
 }
 
 def get_config_path() -> Path:
@@ -117,7 +114,7 @@ def get_endpoint() -> str:
 
 
 def get_gateway_url() -> str:
-    """Get the ingest gateway base URL (POST /ingest, GET /ws/device)."""
+    """Get the ingest gateway base URL (POST /ingest)."""
     env_gateway = os.environ.get("PLEXUS_GATEWAY_URL")
     if env_gateway:
         return env_gateway.rstrip("/")
@@ -125,6 +122,15 @@ def get_gateway_url() -> str:
     return (config.get("gateway_url") or PLEXUS_GATEWAY_URL).rstrip("/")
 
 
+def get_gateway_ws_url() -> str:
+    """Get the gateway WebSocket base URL (/ws/device)."""
+    env_ws = os.environ.get("PLEXUS_GATEWAY_WS_URL")
+    if env_ws:
+        return env_ws.rstrip("/")
+    config = load_config()
+    return (config.get("gateway_ws_url") or PLEXUS_GATEWAY_WS_URL).rstrip("/")
+
+
 def get_source_id() -> Optional[str]:
     """Get the source ID, generating one if not set."""
     config = load_config()
@@ -139,30 +145,6 @@ def get_source_id() -> Optional[str]:
     return source_id
 
 
-def get_org_id() -> Optional[str]:
-    """Get the organization ID from config or environment variable."""
-    # Environment variable takes precedence
-    env_org = os.environ.get("PLEXUS_ORG_ID")
-    if env_org:
-        return env_org
-
-    config = load_config()
-    return config.get("org_id")
-
-
-def is_logged_in() -> bool:
-    """Check if device is authenticated (has API key)."""
-    return get_api_key() is not None
-
-
-def require_login() -> None:
-    """Raise an error if not logged in."""
-    if not is_logged_in():
-        raise RuntimeError(
-            "Not logged in. Run 'plexus start' to connect your account."
-        )
-
-
 def get_persistent_buffer() -> bool:
     """Get persistent buffer setting. Default True (store-and-forward enabled)."""
     config = load_config()

plexus_python-0.2.0.dist-info/METADATA

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: plexus-python
+Version: 0.2.0
+Summary: Thin Python SDK for Plexus — send telemetry in one line
+Project-URL: Homepage, https://plexus.dev
+Project-URL: Documentation, https://docs.plexus.dev
+Project-URL: Repository, https://github.com/plexus-oss/plexus-python
+Project-URL: Issues, https://github.com/plexus-oss/plexus-python/issues
+Author-email: Plexus <hello@plexus.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: fleet,hardware,iot,monitoring,observability,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: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# plexus-python
+
+**Thin Python SDK for [Plexus](https://plexus.company).** Send telemetry to the Plexus gateway in one line. Storage, dashboards, alerts, and fleet management live in the platform — this package just ships your data.
+
+[![PyPI](https://img.shields.io/pypi/v/plexus-python)](https://pypi.org/project/plexus-python/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+
+## Quick Start
+
+```bash
+pip install plexus-python
+```
+
+```python
+from plexus import Plexus
+
+px = Plexus(api_key="plx_xxx", source_id="device-001")
+px.send("temperature", 72.5)
+```
+
+Get an API key at [app.plexus.company](https://app.plexus.company) → Devices → Add Device.
+
+## Usage
+
+```python
+from plexus import Plexus
+
+px = Plexus(source_id="rig-01")   # reads PLEXUS_API_KEY from env
+
+# Numbers
+px.send("engine.rpm", 3450)
+px.send("coolant.temperature", 82.3, tags={"unit": "C"})
+
+# Strings, bools, objects, arrays — all JSON-serializable
+px.send("vehicle.state", "RUNNING")
+px.send("motor.enabled", True)
+px.send("position", {"x": 1.5, "y": 2.3, "z": 0.8})
+
+# Batch
+px.send_batch([
+    ("temperature", 72.5),
+    ("pressure", 1013.25),
+])
+
+# Named run for grouping related data
+with px.run("thermal-cycle-001"):
+    while running:
+        px.send("temperature", read_temp())
+```
+
+## Bring Your Own Protocol
+
+This package ships no adapters, auto-detection, or daemons — just the client. Use whatever library you'd use anyway and pipe values into `px.send()`.
+
+```python
+# MAVLink (pymavlink)
+for msg in conn:
+    if msg.get_type() == "ATTITUDE":
+        px.send("attitude.roll", msg.roll)
+
+# CAN (python-can)
+for msg in bus:
+    px.send(f"can.0x{msg.arbitration_id:x}", int.from_bytes(msg.data, "big"))
+
+# MQTT (paho-mqtt)
+def on_message(_c, _u, msg):
+    px.send(msg.topic.replace("/", "."), float(msg.payload))
+
+# I2C sensor (Adafruit CircuitPython)
+px.send("temperature", bme.temperature)
+```
+
+See [`examples/`](examples/) for runnable versions of each.
+
+## Reliability
+
+Every send buffers locally before hitting the network, retries with exponential backoff, and keeps your data safe across outages. Enable SQLite persistence to survive restarts and power loss:
+
+```python
+px = Plexus(persistent_buffer=True)
+```
+
+Point counts and flush:
+
+```python
+px.buffer_size()
+px.flush_buffer()
+```
+
+## Environment Variables
+
+| Variable                | Description                  | Default                          |
+| ----------------------- | ---------------------------- | -------------------------------- |
+| `PLEXUS_API_KEY`        | API key (required)           | none                             |
+| `PLEXUS_GATEWAY_URL`    | HTTP ingest URL              | `https://plexus-gateway.fly.dev` |
+| `PLEXUS_GATEWAY_WS_URL` | WebSocket URL (unused in SDK, for compatibility) | `wss://plexus-gateway.fly.dev` |
+
+## Architecture
+
+```
+Your code ── px.send() ── HTTP POST /ingest ──> plexus-gateway ──> ClickHouse + Dashboard
+```
+
+One thin path. No agent, no daemon, no adapters. If you want the full HardwareOps platform — dashboards, alerts, RCA, fleet views — that's the web UI at app.plexus.company. This package gets your data there.
+
+## License
+
+Apache 2.0

plexus_python-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+plexus/__init__.py,sha256=Kal4qSrpQ6S8-AE7F9UqFkJMvbhTD82kzkO59O-ruEw,282
+plexus/buffer.py,sha256=3ykybqLs7yMXxQWFajAT8nGe3cs_lW8_6Xvn0vQ69dE,9262
+plexus/client.py,sha256=X6gyFYS-CVwcqJt_VzwHuNtsuJhJJzSxH41T7UBv9dE,16212
+plexus/config.py,sha256=RNym2Fon6JOCVi1rXPSRWjPFAdT8DSmokY5JPEljQOc,4450
+plexus_python-0.2.0.dist-info/METADATA,sha256=51nhbClqTy2w07qn--JyzD8wAOnM7OQQhydvYUgswRI,4528
+plexus_python-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+plexus_python-0.2.0.dist-info/licenses/LICENSE,sha256=nm3qP1F-JAGcfLpRVtIX24L20LMnRpxmZ2oKZzFpLVo,10755
+plexus_python-0.2.0.dist-info/RECORD,,

plexus/__main__.py

@@ -1,4 +0,0 @@
-"""Allow running plexus as: python3 -m plexus"""
-from plexus.cli import main
-
-main()

plexus/adapters/__init__.py

@@ -1,122 +0,0 @@
-"""
-Protocol Adapters - Extensible protocol support for Plexus
-
-This module provides a plugin system for protocol adapters, enabling
-Plexus to ingest data from any protocol without modifying core code.
-
-Built-in adapters:
-    - MQTTAdapter: Bridge MQTT brokers to Plexus
-    - CANAdapter: CAN bus with DBC signal decoding
-    - MAVLinkAdapter: MAVLink for drones and autonomous vehicles
-    - OPCUAAdapter: OPC-UA client for industrial automation servers
-    - SerialAdapter: Serial port (USB/UART/RS-232/RS-485) reader
-
-Usage:
-    from plexus.adapters import MQTTAdapter, CANAdapter, MAVLinkAdapter, AdapterRegistry
-
-    # Use built-in adapter
-    adapter = MQTTAdapter(broker="localhost", topic="sensors/#")
-    adapter.connect()
-    adapter.run(on_data=my_callback)
-
-    # CAN bus adapter
-    adapter = CANAdapter(interface="socketcan", channel="can0", dbc_path="vehicle.dbc")
-    with adapter:
-        for metric in adapter.poll():
-            print(f"{metric.name}: {metric.value}")
-
-    # MAVLink adapter
-    adapter = MAVLinkAdapter(connection_string="udpin:0.0.0.0:14550")
-    with adapter:
-        for metric in adapter.poll():
-            print(f"{metric.name}: {metric.value}")
-
-    # Create custom adapter
-    from plexus.adapters import ProtocolAdapter, Metric
-
-    class MyProtocolAdapter(ProtocolAdapter):
-        def connect(self) -> bool:
-            # Connect to your protocol
-            return True
-
-        def poll(self) -> "List[Metric]":
-            # Read data and return metrics
-            return [Metric("sensor.temp", 72.5)]
-
-    # Register custom adapter
-    AdapterRegistry.register("my-protocol", MyProtocolAdapter)
-"""
-
-from plexus.adapters.base import (
-    ProtocolAdapter,
-    Metric,
-    AdapterConfig,
-    AdapterState,
-    AdapterError,
-)
-from plexus.adapters.registry import AdapterRegistry
-from plexus.adapters.mqtt import MQTTAdapter
-
-# Import CANAdapter (requires optional [can] extra)
-try:
-    from plexus.adapters.can import CANAdapter
-    _HAS_CAN = True
-except ImportError:
-    CANAdapter = None  # type: ignore
-    _HAS_CAN = False
-
-# Import ModbusAdapter (requires optional [modbus] extra)
-try:
-    from plexus.adapters.modbus import ModbusAdapter
-    _HAS_MODBUS = True
-except ImportError:
-    ModbusAdapter = None  # type: ignore
-    _HAS_MODBUS = False
-
-# Import MAVLinkAdapter (requires optional [mavlink] extra)
-try:
-    from plexus.adapters.mavlink import MAVLinkAdapter
-    _HAS_MAVLINK = True
-except ImportError:
-    MAVLinkAdapter = None  # type: ignore
-    _HAS_MAVLINK = False
-
-# Import OPCUAAdapter (requires optional [opcua] extra)
-try:
-    from plexus.adapters.opcua import OPCUAAdapter
-    _HAS_OPCUA = True
-except ImportError:
-    OPCUAAdapter = None  # type: ignore
-    _HAS_OPCUA = False
-
-# Import SerialAdapter (requires optional [serial] extra)
-try:
-    from plexus.adapters.serial_adapter import SerialAdapter
-    _HAS_SERIAL = True
-except ImportError:
-    SerialAdapter = None  # type: ignore
-    _HAS_SERIAL = False
-
-# Import BLERelayAdapter (requires optional [ble] extra)
-try:
-    from plexus.adapters.ble import BLERelayAdapter
-    _HAS_BLE = True
-except ImportError:
-    BLERelayAdapter = None  # type: ignore
-    _HAS_BLE = False
-
-__all__ = [
-    "ProtocolAdapter",
-    "Metric",
-    "AdapterConfig",
-    "AdapterState",
-    "AdapterError",
-    "AdapterRegistry",
-    "MQTTAdapter",
-    "CANAdapter",
-    "ModbusAdapter",
-    "MAVLinkAdapter",
-    "OPCUAAdapter",
-    "SerialAdapter",
-    "BLERelayAdapter",
-]