feat(sdk): refactor Python SDK documentation
- Standardize Python SDK (`datastack`) documentation with a new multi-file suite. - Update `datastack-sdk` to serve as a backward-compatible shim for the canonical `datastack` package. - Update project manifest and memory map to reflect current SDK structure and v2.2.0 features.
This commit is contained in:
1 parent
4279da45bb
commit
40a6855724
38 files changed
+3315
-141
No files matched your search
@@ -91,6 +91,21 @@ Cleanly closes the active Socket.IO connection.
|
||||
|
||||
---
|
||||
|
||||
## Canonical Documentation Suite
|
||||
|
||||
For exhaustive documentation on configuration auto-discovery, HTTP fallback, offline disk spooling, direct file streaming, and error handling, consult the canonical documentation:
|
||||
|
||||
- **[Python SDK Documentation Hub](../sdk/python/datastack/docs/README.md)**
|
||||
- **[Installation Guide](../sdk/python/datastack/docs/INSTALLATION.md)**
|
||||
- **[Quickstart Guide](../sdk/python/datastack/docs/QUICKSTART.md)**
|
||||
- **[API Reference](../sdk/python/datastack/docs/API_REFERENCE.md)**
|
||||
- **[Configuration Guide](../sdk/python/datastack/docs/CONFIGURATION.md)**
|
||||
- **[Practical Examples](../sdk/python/datastack/docs/EXAMPLES.md)**
|
||||
- **[Error Handling Guide](../sdk/python/datastack/docs/ERROR_HANDLING.md)**
|
||||
- **[Lifecycle & Resilience](../sdk/python/datastack/docs/LIFECYCLE.md)**
|
||||
|
||||
---
|
||||
|
||||
## Author & Support
|
||||
|
||||
Developed and maintained by **[Vib Tools](https://vib.tools/)**:
|
||||
|
||||
+15
-6
@@ -1,10 +1,19 @@
|
||||
# Python SDK Manifest
|
||||
# Python SDK Manifest (`datastack-sdk`)
|
||||
|
||||
## Purpose
|
||||
Pip-installable Python client SDK (`datastack-sdk`) enabling Python services, IoT telemetry agents, and analytics applications to stream structured real-time events to DataStack.
|
||||
Pip-installable Python client SDK compatibility alias (`datastack-sdk`), providing full backward compatibility for applications importing from `datastack_sdk` while sharing a single source of truth with the canonical `datastack` package (`sdk/python/datastack/`).
|
||||
|
||||
## Contents
|
||||
- `setup.py`: Package metadata and dependencies (`python-socketio[client]`, `requests`).
|
||||
- `datastack_sdk/__init__.py`: Exports `DataStackClient`.
|
||||
- `datastack_sdk/client.py`: `DataStackClient` implementation featuring JWT handshake authentication, automatic reconnection, and thread-safe acknowledgment waiting (`threading.Event`) for `sync()` and `batch_sync()`.
|
||||
- `README.md`: Installation instructions, quickstart example, and API reference.
|
||||
- `setup.py`: Package distribution metadata and dependencies (`python-socketio[client]`, `requests`, `websocket-client`).
|
||||
- `datastack_sdk/`:
|
||||
- `__init__.py`: Package entry point re-exporting all canonical symbols (`DataStack`, `DataStackClient`, `DataStackConfig`, exceptions, `HeartbeatMonitor`, `DiskSpooler`).
|
||||
- `client.py`: Re-export shim for `DataStack` / `DataStackClient`.
|
||||
- `config.py`: Re-export shim for `load_config` and `DataStackConfig`.
|
||||
- `exceptions.py`: Re-export shim for the full exception hierarchy.
|
||||
- `heartbeat.py`: Re-export shim for `ConnectionState` and `HeartbeatMonitor`.
|
||||
- `spool.py`: Re-export shim for `DiskSpooler`.
|
||||
- `README.md`: Installation instructions, quickstart guide, API reference, and cross-references to the canonical documentation suite.
|
||||
|
||||
## Canonical Documentation
|
||||
Full technical documentation (API reference, configuration, examples, error handling, and lifecycle) is maintained at:
|
||||
`sdk/python/datastack/docs/`
|
||||
Reference in new issue
Block a user