dimos-cdrgen 0.1.0__tar.gz

dimos_cdrgen-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

dimos_cdrgen-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+graft dimos_cdrgen/.upstream/rosidl_adapter
+include dimos_cdrgen/parser-source.json
+include dimos_cdrgen/test-sources.json
+include dimos_cdrgen/test_*.py dimos_cdrgen/prepare_test_inputs.py
+graft examples
+global-exclude __pycache__ *.pyc

dimos_cdrgen-0.1.0/NOTICE

@@ -0,0 +1,28 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2025 Dimensional Inc.
+
+   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.
+
+Source provenance:
+Derived from the public DimensionalOS/dimos CDR proposal at commit
+a40ae998f0bdde565e68b6bc123c7154f891caef:
+https://github.com/dimensionalOS/dimos/tree/a40ae998f0bdde565e68b6bc123c7154f891caef/dimos/message_codegen
+
+This distribution reorganizes that code into a standalone package, renames the
+Python distribution/import/CLI, and extracts the existing C++ CDR helper.
+Original first-party copyright headers are retained. The upstream ROSIDL parser
+is prepared unchanged from the revision and hashes in parser-source.json; its
+Apache-2.0 license is included in built Python artifacts under rosidl_adapter.

dimos_cdrgen-0.1.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: dimos-cdrgen
+Version: 0.1.0
+Summary: ROS-free message generation and CDR codecs for Python, C++ and Rust
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/TomCC7/dimos-cdrgen
+Project-URL: Issues, https://github.com/TomCC7/dimos-cdrgen/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: rosbags==0.11.0
+Requires-Dist: empy==4.2
+Requires-Dist: lark==1.2.2
+Requires-Dist: setuptools>=70
+Requires-Dist: wheel
+Requires-Dist: tomli>=2; python_version < "3.11"
+Provides-Extra: prepare
+Requires-Dist: requests>=2.31; extra == "prepare"
+Provides-Extra: native
+Requires-Dist: pip; extra == "native"
+Requires-Dist: catkin-pkg==1.1.0; extra == "native"
+Requires-Dist: PyYAML==6.0.2; extra == "native"
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: mypy==1.19.0; extra == "test"
+Requires-Dist: types-setuptools; extra == "test"
+Requires-Dist: types-requests; extra == "test"
+Requires-Dist: requests>=2.31; extra == "test"
+Requires-Dist: build; extra == "test"
+Requires-Dist: numpy>=1.26.4; extra == "test"
+Dynamic: license-file
+
+# DimOS message generation and CDR
+
+A standalone `.msg` generator and CDR toolkit for Python, C++ and Rust. It does
+not depend on the DimOS runtime, a ROS installation, or a running robot.
+The package is named `dimos-cdrgen` (import `dimos_cdrgen`). No registry release
+is assumed by these instructions.
+
+## Documentation
+
+The [documentation source](docs/index.md) includes installation, Python, C++, and
+Rust quickstarts, dependency reuse, and CLI/API references. To build and preview
+the MkDocs site locally, follow [the docs maintenance guide](docs/contributing-docs.md).
+The site build uses its own locked environment and does not install this package.
+The [publishing guide](docs/publishing.md) covers local distribution validation,
+the default GitHub dry-run, and approval of registry ownership and OIDC setup.
+
+## Install the tool
+
+From this package directory, prepare the pinned upstream parser and build local
+artifacts. The preparation environment needs `requests`; the build environment
+needs `build`, setuptools 77 or newer, and wheel.
+
+```sh
+python dimos_cdrgen/prepare_parser.py
+python -m build --no-isolation
+python -m pip install dist/dimos_cdrgen-0.1.0-py3-none-any.whl
+```
+
+The wheel and source archive contain the unchanged, hash-verified ROSIDL parser
+and its license. Installing either artifact does not download upstream source.
+A checkout with no prepared parser fails with an explicit preparation error.
+Use `--offline` with a populated cache, or `--archive /path/to/rosidl.tar.gz`.
+Normal Python dependencies must also be available for an offline installation.
+
+## Define and generate a message
+
+In a separate directory, create `interfaces/example_msgs/msg/Reading.msg`:
+
+```text
+int32 sequence
+float64 value
+```
+
+Create `pyproject.toml`:
+
+```toml
+[project]
+name = "acme"
+version = "0.1.0"
+
+[tool.dimos.messages]
+source = "interfaces"
+```
+
+```sh
+dimos-cdrgen
+python -m pip install build/message-source/python
+```
+
+Generation reads the configuration and writes the following artifacts. It does
+not invoke a compiler or install a system toolchain.
+
+| Path under `build/message-source` | Artifact |
+| --- | --- |
+| `python/` | Installable Python project, type stubs and schema provider. |
+| `cpp/` | CMake projects and owned `.msg` sources for upstream ROSIDL/FastRTPS. |
+| `rust/` | Cargo crate, `.msg` sources and a ros2msg `build.rs`. |
+| `schemas/`, `schemas.json` | Complete schema closure, including dependency messages. |
+| `message-package.json` | Ownership, exact dependency versions, hashes and ABI. |
+
+### Python
+
+```python
+from acme.example_msgs.msg import Reading
+from dimos_cdrgen.registry import encode, decode
+
+message = Reading(sequence=1, value=21.5)
+assert decode(encode(message), Reading).value == 21.5
+```
+
+Runtime values and codecs use rosbags. Python wheels need no native compiler;
+there is no pybind extension. Import initializes the type registry without
+writing generated files or compiling code. Numeric arrays use NumPy.
+
+### C++
+
+Install the tool's `native` extra and supply CMake plus a C/C++ compiler.
+Prepare the generated package explicitly; pinned upstream dependencies are
+fetched and verified here, not during Python import or installation.
+
+```python
+from pathlib import Path
+from dimos_cdrgen.native_build import prepare_cpp, write_cmake_toolchain
+
+prefix = prepare_cpp(Path("build/message-source"))
+write_cmake_toolchain(prefix, Path("build/acme-toolchain.cmake"))
+```
+
+For an application containing `main.cpp`, use:
+
+```cmake
+cmake_minimum_required(VERSION 3.20)
+project(reader LANGUAGES CXX)
+find_package(acme CONFIG REQUIRED)
+add_executable(reader main.cpp)
+target_compile_features(reader PRIVATE cxx_std_17)
+target_link_libraries(reader PRIVATE acme::messages)
+```
+
+```cpp
+#include <example_msgs/msg/reading.hpp>
+#include <dimos_cdrgen/cdr.hpp>
+int main() {
+    example_msgs::msg::Reading message;
+    message.sequence = 1;
+    message.value = 21.5;
+    auto wire = dimos::cdr::cdr_encode(message);
+    auto decoded = dimos::cdr::cdr_decode<example_msgs::msg::Reading>(wire);
+    return decoded.value == 21.5 ? 0 : 1;
+}
+```
+
+```sh
+cmake -S . -B build/app -DCMAKE_TOOLCHAIN_FILE="$PWD/build/acme-toolchain.cmake"
+cmake --build build/app
+./build/app/reader
+```
+
+The prefix contains generated headers, shared libraries and CMake exports.
+The CDR helper is supplied by this library, with no DimOS SDK include path.
+For offline preparation, use `prepare_cpp(..., offline=True)` with a populated
+verified source/build cache. macOS also requires Apple's SDK and command-line tools.
+
+### Rust
+
+In a Cargo application next to `build/`, declare:
+
+```toml
+[workspace]
+exclude = ["build/message-source/rust"]
+
+[dependencies]
+acme-messages = { path = "build/message-source/rust" }
+re_cdr = "=0.1.0"
+```
+
+```rust
+use acme_messages::example_msgs::msg::reading::Reading;
+fn main() {
+    let message = Reading { sequence: 1, value: 21.5 };
+    let body = re_cdr::to_vec::<_, re_cdr::LittleEndian>(&message).unwrap();
+    let mut wire = vec![0, 1, 0, 0]; // plain little-endian CDR encapsulation
+    wire.extend(body);
+    let (decoded, used) =
+        re_cdr::from_bytes::<Reading, re_cdr::LittleEndian>(&wire[4..]).unwrap();
+    assert_eq!(decoded.value, 21.5);
+    assert_eq!(used, wire.len() - 4);
+}
+```
+
+`cargo run` invokes ros2msg through the generated `build.rs`, writes declarations
+into Cargo's `OUT_DIR`, and compiles the crate into the application. Use
+`cargo run --offline` with cached dependencies. This does not create a Python
+extension or publish a crate.
+
+## Dependency ownership and DimOS integration
+
+Standard ROS message definitions are a separate catalog, not bundled here.
+Declare an installed message package in `tool.dimos.messages.dependencies` with
+its exact module/version. The generator imports its Python types, links its C++
+declarations, and reuses its Rust crate types. It rejects conflicting ownership,
+versions and schema hashes. The full schema closure remains available for MCAP
+schema registration by consumers; this library itself does not record MCAP.
+
+The DimOS `dimos-build-config` adapter from PR #4461 calls this library's
+`package_settings()` to support `pip install .` and editable projects alongside
+blueprint declarations. Existing setuptools callers can use `setup_arguments()`.
+Both call the same `prepare()` implementation as `dimos-cdrgen`.
+Neither requires copying the generator into a DimOS application. Reinstall an
+editable message project and restart Python processes after changing `.msg` files.
+
+The codec provides schema/CDR interoperability. It does not implement a ROS 2
+node, DDS discovery, topic QoS, or live ROS 2 network interoperability. Unsupported
+bounds and declared-default semantics remain explicit in the generated manifest
+and the [known limitations](https://github.com/dimensionalOS/dimos/blob/cc/feat/remove-lcm-encoding/docs/development/message-limitations.md).
+
+## Run tests from this package alone
+
+```sh
+python -m pip install '.[test,native]'
+PYTHONPATH=. python -m dimos_cdrgen.prepare_test_inputs
+PYTHONPATH=. python -m pytest dimos_cdrgen
+# Explicit compiled Python/C++/Rust exchange (requires native toolchains):
+PYTHONPATH=. DIMOS_NATIVE_ACCEPTANCE=1 python -m pytest dimos_cdrgen/test_native_consumer.py
+```
+
+Test preparation downloads only pinned public upstream test schemas. Use
+`--offline --cache /path/to/verified/archives` to reuse archives. Native acceptance
+can use `DIMOS_OFFLINE=1`, `DIMOS_NATIVE_TEST_CACHE`, and `DIMOS_NATIVE_SOURCE_DIRS`
+(a JSON map of upstream project names to prepared source directories). Isolated
+installation tests require `DIMOS_MESSAGE_WHEELHOUSE` containing the Python build
+and runtime dependency wheels. The optional joint DimOS adapter test also needs
+`DIMOS_BUILD_CONFIG_SOURCE`; it is not required to use the standalone library.
+
+## Prepare a release; do not publish yet
+
+Use the [publishing guide](docs/publishing.md) for the locked build environment,
+standalone consumer checks, and manual `dry-run`, `testpypi`, or `pypi` workflow.
+The default `dry-run` never uploads. A real upload requires an approved registry
+account and project, Trusted Publisher configuration, and a matching version tag.
+
+1. Confirm the authorized registry account and publishing destination.
+   The current `0.1.0` metadata is a development candidate, not an existing release.
+2. Prepare the pinned parser, then build the wheel and sdist in a clean directory.
+   Retain upstream licenses and source hashes. Do not commit prepared upstream code.
+3. Run `python -m twine check dist/*`, install the wheel in a clean environment,
+   rebuild from the sdist offline, and run the language/dependency acceptance tests.
+4. Choose the supported Python/platform matrix and verify those targets before
+   declaring release support. Linux checks alone do not validate macOS.
+5. Only after approval of the account and destination, use the registry's
+   authorized publishing flow. No upload command is part of build or install.
+
+C++ prefixes and generated Rust crates are separate native build artifacts.
+Publishing the Python tool does not publish a standard-message catalog or Cargo
+packages. Packaged Rust dependencies use exact versions and need normal Cargo
+resolution (local patches/workspaces or separately published dependency crates).