robonix-api 0.1.0rc1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,127 @@
1
+ 木兰宽松许可证, 第2版
2
+
3
+ 木兰宽松许可证, 第2版
4
+ 2020年1月 http://license.coscl.org.cn/MulanPSL2
5
+
6
+
7
+ 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束:
8
+
9
+ 0. 定义
10
+
11
+ “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
12
+
13
+ “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
14
+
15
+ “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
16
+
17
+ “法人实体”是指提交贡献的机构及其“关联实体”。
18
+
19
+ “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
20
+
21
+ 1. 授予版权许可
22
+
23
+ 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。
24
+
25
+ 2. 授予专利许可
26
+
27
+ 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
28
+
29
+ 3. 无商标许可
30
+
31
+ “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。
32
+
33
+ 4. 分发限制
34
+
35
+ 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。
36
+
37
+ 5. 免责声明与责任限制
38
+
39
+ “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。
40
+
41
+ 6. 语言
42
+ “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。
43
+
44
+ 条款结束
45
+
46
+ 如何将木兰宽松许可证,第2版,应用到您的软件
47
+
48
+ 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步:
49
+
50
+ 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字;
51
+
52
+ 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中;
53
+
54
+ 3, 请将如下声明文本放入每个源文件的头部注释中。
55
+
56
+ Copyright (c) [Year] [name of copyright holder]
57
+ [Software Name] is licensed under Mulan PSL v2.
58
+ You can use this software according to the terms and conditions of the Mulan PSL v2.
59
+ You may obtain a copy of Mulan PSL v2 at:
60
+ http://license.coscl.org.cn/MulanPSL2
61
+ THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
62
+ See the Mulan PSL v2 for more details.
63
+
64
+
65
+ Mulan Permissive Software License,Version 2
66
+
67
+ Mulan Permissive Software License,Version 2 (Mulan PSL v2)
68
+ January 2020 http://license.coscl.org.cn/MulanPSL2
69
+
70
+ Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
71
+
72
+ 0. Definition
73
+
74
+ Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
75
+
76
+ Contribution means the copyrightable work licensed by a particular Contributor under this License.
77
+
78
+ Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
79
+
80
+ Legal Entity means the entity making a Contribution and all its Affiliates.
81
+
82
+ Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
83
+
84
+ 1. Grant of Copyright License
85
+
86
+ Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
87
+
88
+ 2. Grant of Patent License
89
+
90
+ Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
91
+
92
+ 3. No Trademark License
93
+
94
+ No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4.
95
+
96
+ 4. Distribution Restriction
97
+
98
+ You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
99
+
100
+ 5. Disclaimer of Warranty and Limitation of Liability
101
+
102
+ THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
103
+
104
+ 6. Language
105
+
106
+ THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
107
+
108
+ END OF THE TERMS AND CONDITIONS
109
+
110
+ How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software
111
+
112
+ To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
113
+
114
+ i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner;
115
+
116
+ ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package;
117
+
118
+ iii Attach the statement to the appropriate annotated syntax at the beginning of each source file.
119
+
120
+
121
+ Copyright (c) [Year] [name of copyright holder]
122
+ [Software Name] is licensed under Mulan PSL v2.
123
+ You can use this software according to the terms and conditions of the Mulan PSL v2.
124
+ You may obtain a copy of Mulan PSL v2 at:
125
+ http://license.coscl.org.cn/MulanPSL2
126
+ THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
127
+ See the Mulan PSL v2 for more details.
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.4
2
+ Name: robonix-api
3
+ Version: 0.1.0rc1
4
+ Summary: Robonix Python client library: write Primitive/Service/Skill packages, talk to atlas, serve Driver lifecycle gRPC, wrap rclpy/FastMCP/grpcio middleware.
5
+ Author-email: wheatfox <wheatfox17@icloud.com>
6
+ License: MulanPSL-2.0
7
+ Project-URL: Homepage, https://github.com/syswonder/robonix
8
+ Project-URL: Documentation, https://github.com/syswonder/robonix/tree/main/docs
9
+ Project-URL: Repository, https://github.com/syswonder/robonix
10
+ Project-URL: Issues, https://github.com/syswonder/robonix/issues
11
+ Keywords: robotics,robonix,embodied-ai,ros2,mcp,grpc
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Topic :: Scientific/Engineering
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Requires-Python: >=3.10
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: grpcio>=1.50
27
+ Requires-Dist: protobuf>=4
28
+ Requires-Dist: mcp>=1.0
29
+ Requires-Dist: fastmcp>=3
30
+ Requires-Dist: pyyaml>=6
31
+ Provides-Extra: codegen
32
+ Requires-Dist: grpcio-tools>=1.50; extra == "codegen"
33
+ Dynamic: license-file
34
+
35
+ # robonix-api
36
+
37
+ Python client library for writing [Robonix](https://github.com/syswonder/robonix) capability providers — primitives, services, and skills — and talking to the Atlas registry.
38
+
39
+ > Robonix is an embodied-AI operating system. `robonix-api` is the **client-side helper**: it gives you `Primitive` / `Service` / `Skill` classes that handle Atlas registration, the Driver lifecycle gRPC server, and thin wrappers over `rclpy` / `FastMCP` / `grpcio`. The Atlas server itself is a separate Rust binary (`robonix-atlas`, see the main repo).
40
+
41
+ ## Install
42
+
43
+ ```bash
44
+ pip install robonix-api
45
+ ```
46
+
47
+ Optional extras:
48
+
49
+ ```bash
50
+ pip install "robonix-api[codegen]" # adds grpcio-tools, only needed if you run `rbnx codegen` from Python
51
+ ```
52
+
53
+ ROS 2 (`rclpy`, `sensor_msgs`, `geometry_msgs`, etc.) is **not** a pip dependency — install ROS 2 Humble via `apt` on the host. `robonix-api`'s ROS helpers import `rclpy` lazily, so the rest of the library works even without a ROS install.
54
+
55
+ ## Hello, primitive
56
+
57
+ ```python
58
+ from robonix_api import Primitive, Ok, Deferred
59
+
60
+ primitive = Primitive(
61
+ id="my_lidar",
62
+ namespace="robonix/primitive/lidar",
63
+ )
64
+
65
+ @primitive.on_init
66
+ def init(cfg: dict):
67
+ topic = cfg.get("lidar_topic", "/scan")
68
+ if not primitive.wait_for_topic(topic, "LaserScan", 30.0):
69
+ return Deferred(f"no LaserScan on {topic} yet")
70
+ primitive.create_publisher(
71
+ contract_id="robonix/primitive/lidar/lidar2d",
72
+ topic=topic,
73
+ msg_type="LaserScan",
74
+ )
75
+ return Ok()
76
+
77
+ if __name__ == "__main__":
78
+ primitive.run()
79
+ ```
80
+
81
+ That's a complete Robonix primitive — registers with Atlas, serves the Driver lifecycle, waits for the upstream topic, declares a ROS 2 capability for downstream consumers, and blocks on SIGTERM.
82
+
83
+ ## What's in the box
84
+
85
+ - **`ATLAS`** — module-level singleton client (`ATLAS.register`, `ATLAS.find_primitive`, `ATLAS.connect`, ...)
86
+ - **`Primitive` / `Service` / `Skill`** — provider base classes with `on_init` / `on_activate` / `on_deactivate` / `on_shutdown` decorators
87
+ - **`@provider.provides_grpc(contract)` / `@provider.provides_mcp(contract)`** — Layer-2 sugar for typed handlers
88
+ - **`Ok` / `Err` / `Deferred`** — lifecycle return values
89
+ - **`mcp_contract`** — standalone FastMCP decorator (use when you manage your own FastMCP app, e.g. in `scene_service`)
90
+
91
+ The Atlas wire protocol (atlas_pb2 / atlas_pb2_grpc) is pre-generated and bundled in the wheel. Per-contract stubs (`robonix_contracts_pb2`, MCP typed dataclasses) are generated **per deployment** by `rbnx codegen` against your contract TOMLs — `robonix-api` automatically picks them up from `<pkg>/rbnx-build/codegen/` at runtime.
92
+
93
+ ## Versioning
94
+
95
+ `robonix-api` tracks the Robonix v0.1.x series. Wire format and public API are frozen within v0.1.x. Pre-release builds (`0.1.0rc*`) are published to Test PyPI first; stable releases to PyPI.
96
+
97
+ The Atlas server (Rust crate `robonix-atlas`) must be on a compatible minor version. Mixing `robonix-api 0.1.x` with an Atlas server on a different minor version is unsupported.
98
+
99
+ ## Links
100
+
101
+ - [Robonix monorepo](https://github.com/syswonder/robonix) — Atlas server, `rbnx` CLI, examples, full developer guide
102
+ - [Issues](https://github.com/syswonder/robonix/issues)
103
+
104
+ ## License
105
+
106
+ Mulan PSL v2.
@@ -0,0 +1,72 @@
1
+ # robonix-api
2
+
3
+ Python client library for writing [Robonix](https://github.com/syswonder/robonix) capability providers — primitives, services, and skills — and talking to the Atlas registry.
4
+
5
+ > Robonix is an embodied-AI operating system. `robonix-api` is the **client-side helper**: it gives you `Primitive` / `Service` / `Skill` classes that handle Atlas registration, the Driver lifecycle gRPC server, and thin wrappers over `rclpy` / `FastMCP` / `grpcio`. The Atlas server itself is a separate Rust binary (`robonix-atlas`, see the main repo).
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ pip install robonix-api
11
+ ```
12
+
13
+ Optional extras:
14
+
15
+ ```bash
16
+ pip install "robonix-api[codegen]" # adds grpcio-tools, only needed if you run `rbnx codegen` from Python
17
+ ```
18
+
19
+ ROS 2 (`rclpy`, `sensor_msgs`, `geometry_msgs`, etc.) is **not** a pip dependency — install ROS 2 Humble via `apt` on the host. `robonix-api`'s ROS helpers import `rclpy` lazily, so the rest of the library works even without a ROS install.
20
+
21
+ ## Hello, primitive
22
+
23
+ ```python
24
+ from robonix_api import Primitive, Ok, Deferred
25
+
26
+ primitive = Primitive(
27
+ id="my_lidar",
28
+ namespace="robonix/primitive/lidar",
29
+ )
30
+
31
+ @primitive.on_init
32
+ def init(cfg: dict):
33
+ topic = cfg.get("lidar_topic", "/scan")
34
+ if not primitive.wait_for_topic(topic, "LaserScan", 30.0):
35
+ return Deferred(f"no LaserScan on {topic} yet")
36
+ primitive.create_publisher(
37
+ contract_id="robonix/primitive/lidar/lidar2d",
38
+ topic=topic,
39
+ msg_type="LaserScan",
40
+ )
41
+ return Ok()
42
+
43
+ if __name__ == "__main__":
44
+ primitive.run()
45
+ ```
46
+
47
+ That's a complete Robonix primitive — registers with Atlas, serves the Driver lifecycle, waits for the upstream topic, declares a ROS 2 capability for downstream consumers, and blocks on SIGTERM.
48
+
49
+ ## What's in the box
50
+
51
+ - **`ATLAS`** — module-level singleton client (`ATLAS.register`, `ATLAS.find_primitive`, `ATLAS.connect`, ...)
52
+ - **`Primitive` / `Service` / `Skill`** — provider base classes with `on_init` / `on_activate` / `on_deactivate` / `on_shutdown` decorators
53
+ - **`@provider.provides_grpc(contract)` / `@provider.provides_mcp(contract)`** — Layer-2 sugar for typed handlers
54
+ - **`Ok` / `Err` / `Deferred`** — lifecycle return values
55
+ - **`mcp_contract`** — standalone FastMCP decorator (use when you manage your own FastMCP app, e.g. in `scene_service`)
56
+
57
+ The Atlas wire protocol (atlas_pb2 / atlas_pb2_grpc) is pre-generated and bundled in the wheel. Per-contract stubs (`robonix_contracts_pb2`, MCP typed dataclasses) are generated **per deployment** by `rbnx codegen` against your contract TOMLs — `robonix-api` automatically picks them up from `<pkg>/rbnx-build/codegen/` at runtime.
58
+
59
+ ## Versioning
60
+
61
+ `robonix-api` tracks the Robonix v0.1.x series. Wire format and public API are frozen within v0.1.x. Pre-release builds (`0.1.0rc*`) are published to Test PyPI first; stable releases to PyPI.
62
+
63
+ The Atlas server (Rust crate `robonix-atlas`) must be on a compatible minor version. Mixing `robonix-api 0.1.x` with an Atlas server on a different minor version is unsupported.
64
+
65
+ ## Links
66
+
67
+ - [Robonix monorepo](https://github.com/syswonder/robonix) — Atlas server, `rbnx` CLI, examples, full developer guide
68
+ - [Issues](https://github.com/syswonder/robonix/issues)
69
+
70
+ ## License
71
+
72
+ Mulan PSL v2.
@@ -0,0 +1,54 @@
1
+ # SPDX-License-Identifier: MulanPSL-2.0
2
+ [project]
3
+ name = "robonix-api"
4
+ version = "0.1.0rc1"
5
+ description = "Robonix Python client library: write Primitive/Service/Skill packages, talk to atlas, serve Driver lifecycle gRPC, wrap rclpy/FastMCP/grpcio middleware."
6
+ readme = "README.md"
7
+ license = { text = "MulanPSL-2.0" }
8
+ authors = [
9
+ { name = "wheatfox", email = "wheatfox17@icloud.com" },
10
+ ]
11
+ requires-python = ">=3.10"
12
+ keywords = ["robotics", "robonix", "embodied-ai", "ros2", "mcp", "grpc"]
13
+ classifiers = [
14
+ "Development Status :: 3 - Alpha",
15
+ "Intended Audience :: Developers",
16
+ "Intended Audience :: Science/Research",
17
+ "Operating System :: POSIX :: Linux",
18
+ "Programming Language :: Python :: 3",
19
+ "Programming Language :: Python :: 3 :: Only",
20
+ "Programming Language :: Python :: 3.10",
21
+ "Programming Language :: Python :: 3.11",
22
+ "Programming Language :: Python :: 3.12",
23
+ "Topic :: Scientific/Engineering",
24
+ "Topic :: Software Development :: Libraries :: Python Modules",
25
+ ]
26
+ dependencies = [
27
+ "grpcio>=1.50",
28
+ "protobuf>=4",
29
+ "mcp>=1.0",
30
+ "fastmcp>=3",
31
+ "pyyaml>=6",
32
+ ]
33
+
34
+ [project.optional-dependencies]
35
+ codegen = [
36
+ "grpcio-tools>=1.50",
37
+ ]
38
+
39
+ [project.urls]
40
+ Homepage = "https://github.com/syswonder/robonix"
41
+ Documentation = "https://github.com/syswonder/robonix/tree/main/docs"
42
+ Repository = "https://github.com/syswonder/robonix"
43
+ Issues = "https://github.com/syswonder/robonix/issues"
44
+
45
+ [build-system]
46
+ requires = ["setuptools>=61"]
47
+ build-backend = "setuptools.build_meta"
48
+
49
+ [tool.setuptools.packages.find]
50
+ where = ["."]
51
+ include = ["robonix_api*"]
52
+
53
+ [tool.setuptools.package-data]
54
+ robonix_api = ["_generated/*.py"]
@@ -0,0 +1,108 @@
1
+ # SPDX-License-Identifier: MulanPSL-2.0
2
+ """robonix-api — Python helpers for writing Robonix CapabilityProviders.
3
+
4
+ A package instantiates exactly one of `Primitive`, `Service`, or
5
+ `Skill`. The framework talks to atlas, serves the Driver lifecycle
6
+ gRPC, and wraps the common middleware patterns (rclpy / FastMCP /
7
+ grpcio).
8
+
9
+ Layered API:
10
+
11
+ Layer 1 -- always available: declare_capability, connect_capability,
12
+ on_init/on_activate/on_deactivate/on_shutdown handlers,
13
+ spawn subprocess, sentinel waits.
14
+
15
+ Layer 2 -- opt-in convenience: `@provider.provides_grpc(contract)`,
16
+ `@provider.provides_mcp(contract)`, ROS create_publisher /
17
+ create_subscription. Skip if you want to drive rclpy /
18
+ FastMCP / grpcio directly -- just call
19
+ `provider.declare_capability(...)` to register with atlas.
20
+
21
+ Typical usage:
22
+
23
+ from robonix_api import ATLAS, Primitive, Ok, Err, Deferred
24
+
25
+ primitive_mid360 = Primitive(
26
+ id="mid360_lidar",
27
+ namespace="robonix/primitive/lidar",
28
+ )
29
+
30
+ @primitive_mid360.on_init
31
+ def init(cfg: dict):
32
+ topic = cfg.get("lidar_topic", "/scanner/cloud")
33
+ if not primitive_mid360.wait_for_topic(topic, "PointCloud2", 30.0):
34
+ return Deferred(f"no PointCloud2 on {topic} yet")
35
+ primitive_mid360.create_publisher(
36
+ contract_id="robonix/primitive/lidar/lidar3d",
37
+ topic=topic, msg_type="PointCloud2",
38
+ )
39
+ return Ok()
40
+
41
+ if __name__ == "__main__":
42
+ primitive_mid360.run()
43
+ """
44
+ from __future__ import annotations
45
+
46
+ from .atlas import ATLAS
47
+ from .atlas_types import (
48
+ Capability,
49
+ CapabilityProvider,
50
+ Channel,
51
+ ContractDescriptor,
52
+ GrpcParams,
53
+ Kind,
54
+ LifecycleState,
55
+ McpParams,
56
+ Ros2Params,
57
+ Transport,
58
+ )
59
+ from .capability import Primitive, Service, Skill
60
+ from .result import Deferred, Err, Ok, Result
61
+ from .tool import mcp_contract
62
+
63
+
64
+ # -- Auto-bootstrap codegen sys.path ----------------------------------------
65
+ # Walk the import-time call stack to find the user's first frame, locate
66
+ # its package_manifest.yaml, and add the package's
67
+ # `rbnx-build/codegen/{proto_gen,robonix_mcp_types}` to sys.path so the
68
+ # generated atlas_pb2 / contracts modules import cleanly at top-of-file.
69
+
70
+ def _bootstrap_codegen_paths_from_caller() -> None:
71
+ import inspect
72
+ from pathlib import Path
73
+ from .codegen import ensure_proto_gen, find_pkg_root
74
+ here = str(Path(__file__).resolve().parent)
75
+ for fi in inspect.stack():
76
+ f = fi.filename
77
+ if f.startswith(here) or "<frozen" in f or "/importlib/" in f:
78
+ continue
79
+ pkg_root = find_pkg_root(Path(f))
80
+ if pkg_root is not None:
81
+ ensure_proto_gen(pkg_root)
82
+ return # only the first user frame matters
83
+
84
+
85
+ try:
86
+ _bootstrap_codegen_paths_from_caller()
87
+ except Exception: # noqa: BLE001
88
+ # REPL / tests / ad-hoc scripts -- fall back to
89
+ # _ProviderBase.__init__'s ensure_proto_gen call.
90
+ pass
91
+ del _bootstrap_codegen_paths_from_caller
92
+
93
+
94
+ __all__ = [
95
+ # CapabilityProvider classes (three kinds).
96
+ "Primitive", "Service", "Skill",
97
+ # Global atlas singleton (uppercase per Python registry convention,
98
+ # cf. prometheus_client.REGISTRY).
99
+ "ATLAS",
100
+ # Lifecycle handler return type.
101
+ "Ok", "Err", "Deferred", "Result",
102
+ # Atlas dataclass mirrors.
103
+ "Capability", "CapabilityProvider", "Channel", "ContractDescriptor",
104
+ "GrpcParams", "Ros2Params", "McpParams",
105
+ "Kind", "LifecycleState", "Transport",
106
+ # MCP decorator (standalone; `@provider.provides_mcp` is sugar over this).
107
+ "mcp_contract",
108
+ ]
@@ -0,0 +1,102 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
3
+ # NO CHECKED-IN PROTOBUF GENCODE
4
+ # source: atlas.proto
5
+ # Protobuf Python Version: 6.31.1
6
+ """Generated protocol buffer code."""
7
+ from google.protobuf import descriptor as _descriptor
8
+ from google.protobuf import descriptor_pool as _descriptor_pool
9
+ from google.protobuf import runtime_version as _runtime_version
10
+ from google.protobuf import symbol_database as _symbol_database
11
+ from google.protobuf.internal import builder as _builder
12
+ _runtime_version.ValidateProtobufRuntimeVersion(
13
+ _runtime_version.Domain.PUBLIC,
14
+ 6,
15
+ 31,
16
+ 1,
17
+ '',
18
+ 'atlas.proto'
19
+ )
20
+ # @@protoc_insertion_point(imports)
21
+
22
+ _sym_db = _symbol_database.Default()
23
+
24
+
25
+
26
+
27
+ DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0b\x61tlas.proto\x12\rrobonix.atlas\"L\n\x0fRegisterRequest\x12\n\n\x02id\x18\x01 \x01(\t\x12\x11\n\tnamespace\x18\x02 \x01(\t\x12\x1a\n\x12\x63\x61pability_md_path\x18\x03 \x01(\t\"\x1e\n\x10RegisterResponse\x12\n\n\x02id\x18\x01 \x01(\t\"\x1f\n\x11UnregisterRequest\x12\n\n\x02id\x18\x01 \x01(\t\")\n\x12UnregisterResponse\x12\x13\n\x0bwas_present\x18\x01 \x01(\x08\"\x1e\n\x10HeartbeatRequest\x12\n\n\x02id\x18\x01 \x01(\t\"\x13\n\x11HeartbeatResponse\"F\n\nGrpcParams\x12\x12\n\nproto_file\x18\x01 \x01(\t\x12\x14\n\x0cservice_name\x18\x02 \x01(\t\x12\x0e\n\x06method\x18\x03 \x01(\t\"!\n\nRos2Params\x12\x13\n\x0bqos_profile\x18\x01 \x01(\t\"&\n\tMcpParams\x12\x19\n\x11input_schema_json\x18\x01 \x01(\t\"\x98\x01\n\x0fTransportParams\x12)\n\x04grpc\x18\x01 \x01(\x0b\x32\x19.robonix.atlas.GrpcParamsH\x00\x12)\n\x04ros2\x18\x02 \x01(\x0b\x32\x19.robonix.atlas.Ros2ParamsH\x00\x12\'\n\x03mcp\x18\x03 \x01(\x0b\x32\x18.robonix.atlas.McpParamsH\x00\x42\x06\n\x04kind\"\xc8\x01\n\x18\x44\x65\x63lareCapabilityRequest\x12\x13\n\x0bprovider_id\x18\x01 \x01(\t\x12\x13\n\x0b\x63ontract_id\x18\x02 \x01(\t\x12+\n\ttransport\x18\x03 \x01(\x0e\x32\x18.robonix.atlas.Transport\x12\x10\n\x08\x65ndpoint\x18\x04 \x01(\t\x12.\n\x06params\x18\x05 \x01(\x0b\x32\x1e.robonix.atlas.TransportParams\x12\x13\n\x0b\x64\x65scription\x18\x06 \x01(\t\"-\n\x19\x44\x65\x63lareCapabilityResponse\x12\x10\n\x08\x65ndpoint\x18\x01 \x01(\t\"\xd4\x01\n\nCapability\x12\x13\n\x0bprovider_id\x18\x01 \x01(\t\x12*\n\rprovider_kind\x18\x02 \x01(\x0e\x32\x13.robonix.atlas.Kind\x12\x13\n\x0b\x63ontract_id\x18\x03 \x01(\t\x12+\n\ttransport\x18\x04 \x01(\x0e\x32\x18.robonix.atlas.Transport\x12.\n\x06params\x18\x05 \x01(\x0b\x32\x1e.robonix.atlas.TransportParams\x12\x13\n\x0b\x64\x65scription\x18\x06 \x01(\t\"d\n\x18SetLifecycleStateRequest\x12\n\n\x02id\x18\x01 \x01(\t\x12,\n\x05state\x18\x02 \x01(\x0e\x32\x1d.robonix.atlas.LifecycleState\x12\x0e\n\x06\x64\x65tail\x18\x03 \x01(\t\"R\n\x19SetLifecycleStateResponse\x12\x35\n\x0eprevious_state\x18\x01 \x01(\x0e\x32\x1d.robonix.atlas.LifecycleState\"\x82\x02\n\x12\x43\x61pabilityProvider\x12\n\n\x02id\x18\x01 \x01(\t\x12!\n\x04kind\x18\x02 \x01(\x0e\x32\x13.robonix.atlas.Kind\x12\x11\n\tnamespace\x18\x03 \x01(\t\x12\x1a\n\x12\x63\x61pability_md_path\x18\x04 \x01(\t\x12\x19\n\x11last_heartbeat_ms\x18\x05 \x01(\x04\x12,\n\x05state\x18\x06 \x01(\x0e\x32\x1d.robonix.atlas.LifecycleState\x12\x14\n\x0cstate_detail\x18\x07 \x01(\t\x12/\n\x0c\x63\x61pabilities\x18\x08 \x03(\x0b\x32\x19.robonix.atlas.Capability\"\x99\x01\n\x0cQueryRequest\x12!\n\x04kind\x18\x01 \x01(\x0e\x32\x13.robonix.atlas.Kind\x12\n\n\x02id\x18\x02 \x01(\t\x12\x13\n\x0b\x63ontract_id\x18\x03 \x01(\t\x12+\n\ttransport\x18\x04 \x01(\x0e\x32\x18.robonix.atlas.Transport\x12\x18\n\x10namespace_prefix\x18\x05 \x01(\t\"E\n\rQueryResponse\x12\x34\n\tproviders\x18\x01 \x03(\x0b\x32!.robonix.atlas.CapabilityProvider\"\x86\x01\n\x18\x43onnectCapabilityRequest\x12\x13\n\x0b\x63onsumer_id\x18\x01 \x01(\t\x12\x13\n\x0bprovider_id\x18\x02 \x01(\t\x12\x13\n\x0b\x63ontract_id\x18\x03 \x01(\t\x12+\n\ttransport\x18\x04 \x01(\x0e\x32\x18.robonix.atlas.Transport\"q\n\x19\x43onnectCapabilityResponse\x12\x12\n\nchannel_id\x18\x01 \x01(\t\x12\x10\n\x08\x65ndpoint\x18\x02 \x01(\t\x12.\n\x06params\x18\x03 \x01(\x0b\x32\x1e.robonix.atlas.TransportParams\"1\n\x1b\x44isconnectCapabilityRequest\x12\x12\n\nchannel_id\x18\x01 \x01(\t\"0\n\x1c\x44isconnectCapabilityResponse\x12\x10\n\x08was_open\x18\x01 \x01(\x08\"\xd6\x02\n\x12\x43ontractDescriptor\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\x12!\n\x04kind\x18\x03 \x01(\x0e\x32\x13.robonix.atlas.Kind\x12\x0c\n\x04mode\x18\x04 \x01(\t\x12\x13\n\x0bio_msg_type\x18\x05 \x01(\t\x12\x13\n\x0bio_srv_type\x18\x06 \x01(\t\x12\x18\n\x10source_toml_path\x18\x07 \x01(\t\x12,\n\nmsg_fields\x18\x08 \x03(\x0b\x32\x18.robonix.atlas.FieldSpec\x12\x34\n\x12srv_request_fields\x18\t \x03(\x0b\x32\x18.robonix.atlas.FieldSpec\x12\x35\n\x13srv_response_fields\x18\n \x03(\x0b\x32\x18.robonix.atlas.FieldSpec\x12\x13\n\x0b\x64\x65scription\x18\x0b \x01(\t\"h\n\tFieldSpec\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x11\n\ttype_name\x18\x02 \x01(\t\x12\x14\n\x0cis_primitive\x18\x03 \x01(\x08\x12\x10\n\x08is_array\x18\x04 \x01(\x08\x12\x12\n\narray_size\x18\x05 \x01(\r\"+\n\x14QueryContractRequest\x12\x13\n\x0b\x63ontract_id\x18\x01 \x01(\t\"[\n\x15QueryContractResponse\x12\x33\n\x08\x63ontract\x18\x01 \x01(\x0b\x32!.robonix.atlas.ContractDescriptor\x12\r\n\x05\x66ound\x18\x02 \x01(\x08\"0\n\x14ListContractsRequest\x12\x18\n\x10namespace_prefix\x18\x01 \x01(\t\"M\n\x15ListContractsResponse\x12\x34\n\tcontracts\x18\x01 \x03(\x0b\x32!.robonix.atlas.ContractDescriptor\"\x15\n\x13InspectAtlasRequest\"$\n\x14InspectAtlasResponse\x12\x0c\n\x04json\x18\x01 \x01(\t*a\n\tTransport\x12\x19\n\x15TRANSPORT_UNSPECIFIED\x10\x00\x12\x12\n\x0eTRANSPORT_GRPC\x10\x01\x12\x12\n\x0eTRANSPORT_ROS2\x10\x02\x12\x11\n\rTRANSPORT_MCP\x10\x03*R\n\x04Kind\x12\x14\n\x10KIND_UNSPECIFIED\x10\x00\x12\x12\n\x0eKIND_PRIMITIVE\x10\x01\x12\x10\n\x0cKIND_SERVICE\x10\x02\x12\x0e\n\nKIND_SKILL\x10\x03*\x8a\x01\n\x0eLifecycleState\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x14\n\x10STATE_REGISTERED\x10\x01\x12\x12\n\x0eSTATE_INACTIVE\x10\x02\x12\x10\n\x0cSTATE_ACTIVE\x10\x03\x12\x0f\n\x0bSTATE_ERROR\x10\x04\x12\x14\n\x10STATE_TERMINATED\x10\x05\x32\xa4\t\n\x05\x41tlas\x12T\n\x11RegisterPrimitive\x12\x1e.robonix.atlas.RegisterRequest\x1a\x1f.robonix.atlas.RegisterResponse\x12R\n\x0fRegisterService\x12\x1e.robonix.atlas.RegisterRequest\x1a\x1f.robonix.atlas.RegisterResponse\x12P\n\rRegisterSkill\x12\x1e.robonix.atlas.RegisterRequest\x1a\x1f.robonix.atlas.RegisterResponse\x12Q\n\nUnregister\x12 .robonix.atlas.UnregisterRequest\x1a!.robonix.atlas.UnregisterResponse\x12N\n\tHeartbeat\x12\x1f.robonix.atlas.HeartbeatRequest\x1a .robonix.atlas.HeartbeatResponse\x12\x66\n\x11SetLifecycleState\x12\'.robonix.atlas.SetLifecycleStateRequest\x1a(.robonix.atlas.SetLifecycleStateResponse\x12\x66\n\x11\x44\x65\x63lareCapability\x12\'.robonix.atlas.DeclareCapabilityRequest\x1a(.robonix.atlas.DeclareCapabilityResponse\x12\x42\n\x05Query\x12\x1b.robonix.atlas.QueryRequest\x1a\x1c.robonix.atlas.QueryResponse\x12\x66\n\x11\x43onnectCapability\x12\'.robonix.atlas.ConnectCapabilityRequest\x1a(.robonix.atlas.ConnectCapabilityResponse\x12o\n\x14\x44isconnectCapability\x12*.robonix.atlas.DisconnectCapabilityRequest\x1a+.robonix.atlas.DisconnectCapabilityResponse\x12Z\n\rQueryContract\x12#.robonix.atlas.QueryContractRequest\x1a$.robonix.atlas.QueryContractResponse\x12Z\n\rListContracts\x12#.robonix.atlas.ListContractsRequest\x1a$.robonix.atlas.ListContractsResponse\x12W\n\x0cInspectAtlas\x12\".robonix.atlas.InspectAtlasRequest\x1a#.robonix.atlas.InspectAtlasResponseb\x06proto3')
28
+
29
+ _globals = globals()
30
+ _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
31
+ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'atlas_pb2', _globals)
32
+ if not _descriptor._USE_C_DESCRIPTORS:
33
+ DESCRIPTOR._loaded_options = None
34
+ _globals['_TRANSPORT']._serialized_start=2842
35
+ _globals['_TRANSPORT']._serialized_end=2939
36
+ _globals['_KIND']._serialized_start=2941
37
+ _globals['_KIND']._serialized_end=3023
38
+ _globals['_LIFECYCLESTATE']._serialized_start=3026
39
+ _globals['_LIFECYCLESTATE']._serialized_end=3164
40
+ _globals['_REGISTERREQUEST']._serialized_start=30
41
+ _globals['_REGISTERREQUEST']._serialized_end=106
42
+ _globals['_REGISTERRESPONSE']._serialized_start=108
43
+ _globals['_REGISTERRESPONSE']._serialized_end=138
44
+ _globals['_UNREGISTERREQUEST']._serialized_start=140
45
+ _globals['_UNREGISTERREQUEST']._serialized_end=171
46
+ _globals['_UNREGISTERRESPONSE']._serialized_start=173
47
+ _globals['_UNREGISTERRESPONSE']._serialized_end=214
48
+ _globals['_HEARTBEATREQUEST']._serialized_start=216
49
+ _globals['_HEARTBEATREQUEST']._serialized_end=246
50
+ _globals['_HEARTBEATRESPONSE']._serialized_start=248
51
+ _globals['_HEARTBEATRESPONSE']._serialized_end=267
52
+ _globals['_GRPCPARAMS']._serialized_start=269
53
+ _globals['_GRPCPARAMS']._serialized_end=339
54
+ _globals['_ROS2PARAMS']._serialized_start=341
55
+ _globals['_ROS2PARAMS']._serialized_end=374
56
+ _globals['_MCPPARAMS']._serialized_start=376
57
+ _globals['_MCPPARAMS']._serialized_end=414
58
+ _globals['_TRANSPORTPARAMS']._serialized_start=417
59
+ _globals['_TRANSPORTPARAMS']._serialized_end=569
60
+ _globals['_DECLARECAPABILITYREQUEST']._serialized_start=572
61
+ _globals['_DECLARECAPABILITYREQUEST']._serialized_end=772
62
+ _globals['_DECLARECAPABILITYRESPONSE']._serialized_start=774
63
+ _globals['_DECLARECAPABILITYRESPONSE']._serialized_end=819
64
+ _globals['_CAPABILITY']._serialized_start=822
65
+ _globals['_CAPABILITY']._serialized_end=1034
66
+ _globals['_SETLIFECYCLESTATEREQUEST']._serialized_start=1036
67
+ _globals['_SETLIFECYCLESTATEREQUEST']._serialized_end=1136
68
+ _globals['_SETLIFECYCLESTATERESPONSE']._serialized_start=1138
69
+ _globals['_SETLIFECYCLESTATERESPONSE']._serialized_end=1220
70
+ _globals['_CAPABILITYPROVIDER']._serialized_start=1223
71
+ _globals['_CAPABILITYPROVIDER']._serialized_end=1481
72
+ _globals['_QUERYREQUEST']._serialized_start=1484
73
+ _globals['_QUERYREQUEST']._serialized_end=1637
74
+ _globals['_QUERYRESPONSE']._serialized_start=1639
75
+ _globals['_QUERYRESPONSE']._serialized_end=1708
76
+ _globals['_CONNECTCAPABILITYREQUEST']._serialized_start=1711
77
+ _globals['_CONNECTCAPABILITYREQUEST']._serialized_end=1845
78
+ _globals['_CONNECTCAPABILITYRESPONSE']._serialized_start=1847
79
+ _globals['_CONNECTCAPABILITYRESPONSE']._serialized_end=1960
80
+ _globals['_DISCONNECTCAPABILITYREQUEST']._serialized_start=1962
81
+ _globals['_DISCONNECTCAPABILITYREQUEST']._serialized_end=2011
82
+ _globals['_DISCONNECTCAPABILITYRESPONSE']._serialized_start=2013
83
+ _globals['_DISCONNECTCAPABILITYRESPONSE']._serialized_end=2061
84
+ _globals['_CONTRACTDESCRIPTOR']._serialized_start=2064
85
+ _globals['_CONTRACTDESCRIPTOR']._serialized_end=2406
86
+ _globals['_FIELDSPEC']._serialized_start=2408
87
+ _globals['_FIELDSPEC']._serialized_end=2512
88
+ _globals['_QUERYCONTRACTREQUEST']._serialized_start=2514
89
+ _globals['_QUERYCONTRACTREQUEST']._serialized_end=2557
90
+ _globals['_QUERYCONTRACTRESPONSE']._serialized_start=2559
91
+ _globals['_QUERYCONTRACTRESPONSE']._serialized_end=2650
92
+ _globals['_LISTCONTRACTSREQUEST']._serialized_start=2652
93
+ _globals['_LISTCONTRACTSREQUEST']._serialized_end=2700
94
+ _globals['_LISTCONTRACTSRESPONSE']._serialized_start=2702
95
+ _globals['_LISTCONTRACTSRESPONSE']._serialized_end=2779
96
+ _globals['_INSPECTATLASREQUEST']._serialized_start=2781
97
+ _globals['_INSPECTATLASREQUEST']._serialized_end=2802
98
+ _globals['_INSPECTATLASRESPONSE']._serialized_start=2804
99
+ _globals['_INSPECTATLASRESPONSE']._serialized_end=2840
100
+ _globals['_ATLAS']._serialized_start=3167
101
+ _globals['_ATLAS']._serialized_end=4355
102
+ # @@protoc_insertion_point(module_scope)