rosp-sdk 0.1.0__tar.gz

rosp_sdk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["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 SDK
+        run: pip install ".[dev,cli]"
+
+      - name: Lint
+        run: ruff check rosp_sdk/ tests/
+
+      - name: Test SDK
+        run: pytest tests/ -v --tb=short
+
+      - name: Test CLI
+        run: |
+          rosp version
+          rosp validate docs/spec/schemas/examples/mir250.json
+
+      - name: Install gRPC adapter
+        run: |
+          pip install ./adapters/grpc/
+          cd adapters/grpc && pytest tests/ -v --tb=short || true
+
+      - name: Install VDA5050 adapter
+        run: |
+          pip install ./adapters/vda5050/[dev]
+          cd adapters/vda5050 && pytest tests/ -v --tb=short || true

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

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rosp-sdk/
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rosp_sdk-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+.pytest_cache/
+.ruff_cache/
+.venv/
+venv/
+*.so
+.env
+.DS_Store

rosp_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to the ROSP SDK and adapters will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-04-01
+
+### Added
+
+- **ROSP v0.1 Specification** - Complete protocol spec for Description Mode (describe, stream, discover)
+- **Core SDK** (`rosp-sdk`)
+  - `ROSPAdapter` abstract base class with 6 lifecycle methods
+  - `RobotCard` dataclass with 16 fields matching robot-card.schema.json
+  - `StreamMessage`, `StreamQoS`, `CommandResult`, `HealthStatus` models
+  - `ROSPEnvelope` transport-agnostic message format
+  - `Validator` with JSON Schema validation
+  - `CompletenessScorer` with 4 progressive enrichment levels
+  - CLI: `rosp validate`, `rosp inspect`, `rosp export-card`, `rosp version`
+- **Adapter: ROS2** (`rosp-adapter-ros2`)
+  - URDF parsing from `/robot_description`
+  - Topic/service/action introspection
+  - QoS profile mapping (ROS2 QoS -> ROSP StreamQoS)
+  - Presets for TurtleBot3, UR, ABB
+- **Adapter: gRPC** (`rosp-adapter-grpc`)
+  - ROSP-native and generic gRPC robot support
+  - Server reflection auto-discovery
+  - TLS/mTLS authentication
+  - Presets for Boston Dynamics Spot, Viam
+- **Adapter: VDA 5050** (`rosp-adapter-vda5050`)
+  - Full MQTT state/order handling
+  - Automatic Robot Card inference from AGV capabilities
+  - Stream conversion (MQTT state -> StreamMessage)
+  - Orchestrator pattern with state, order, and connection handlers
+- **JSON Schemas** for Robot Card, Integration Manifest, Skill Description
+- **Protobuf** definitions for gRPC transport binding
+- **60 tests** for core SDK, additional tests per adapter
+
+### Known Limitations
+
+- Control Mode (`command`, `coordinate`) is **DRAFT** - interface defined but not production-ready
+- Security enforcement (RBAC, audit logging) specified but not implemented
+- Zenoh transport binding specified but SDK support not yet included

rosp_sdk-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,53 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+* The use of sexualized language or imagery and unwelcome sexual attention
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**conduct@roboswarm.io**.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

rosp_sdk-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to ROSP
+
+Thank you for your interest in ROSP (Robot Open Specification Protocol). We welcome contributions from the robotics community.
+
+## Getting Started
+
+```bash
+git clone https://github.com/FaultLine-labs/rosp.git
+cd rosp
+pip install -e ".[dev,cli]"
+pytest
+```
+
+## How to Contribute
+
+### Reporting Issues
+
+- Use [GitHub Issues](https://github.com/FaultLine-labs/rosp/issues)
+- Include: ROSP version, Python version, OS, adapter (if applicable)
+- For bugs: steps to reproduce, expected vs actual behavior
+
+### Pull Requests
+
+1. Fork the repo and create a branch from `main`
+2. Write tests for new functionality
+3. Ensure all tests pass: `pytest`
+4. Ensure code passes lint: `ruff check .`
+5. Update documentation if needed
+6. Submit a PR with a clear description
+
+### Building a New Adapter
+
+The most impactful contribution is a new adapter. ROSP adapters bridge a robot platform to the protocol.
+
+**Minimum implementation:**
+
+```python
+from rosp_sdk import ROSPAdapter, RobotCard, StreamMessage, HealthStatus
+
+class MyAdapter(ROSPAdapter):
+    async def connect(self) -> None: ...
+    async def disconnect(self) -> None: ...
+    async def describe(self, depth="full") -> RobotCard: ...
+    async def stream(self, topics, qos=None) -> AsyncIterator[StreamMessage]: ...
+    async def discover(self) -> DiscoveryInfo: ...
+    async def health_check(self) -> HealthStatus: ...
+```
+
+See `adapters/ros2/` for a reference implementation and `docs/spec/ROSP-v0.1-adapter-sdk.md` for the full guide.
+
+**Register your adapter** in `pyproject.toml`:
+```toml
+[project.entry-points."rosp.adapters"]
+myplatform = "my_adapter:MyAdapter"
+```
+
+### Adapter Checklist
+
+- [ ] Implements all 5 required `ROSPAdapter` methods
+- [ ] Returns a valid `RobotCard` from `describe()`
+- [ ] `rosp validate` passes on the generated Robot Card
+- [ ] Completeness score is documented
+- [ ] Tests included (unit tests, no real hardware needed)
+- [ ] README with install instructions and usage example
+- [ ] `pyproject.toml` with proper dependencies and entry point
+
+## Code Style
+
+- Python 3.10+
+- Formatted with [ruff](https://docs.astral.sh/ruff/) (line length: 100)
+- Type hints on all public APIs
+- Docstrings on all public classes and methods
+
+## Spec Contributions
+
+Protocol specification changes go through a different process:
+1. Open an issue tagged `spec` describing the proposed change
+2. Discuss in the issue before submitting a PR
+3. Changes to the spec require a version bump (e.g., v0.1 -> v0.2)
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

rosp_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 RoboSwarm (FaultLine Labs)
+
+   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.