inorbit-connector
A Python framework for developing connectors for the InOrbit RobOps ecosystem.
Overview
This repository contains a Python framework that provides a base structure for developing InOrbit robot connectors.
Making use of InOrbit's Edge SDK, inorbit-connector provides a starting point for the integration of a fleet of robots in InOrbit, unlocking interoperability.
The framework includes:
- Single-robot (
Connector) and fleet (FleetConnector) base classes - Built-in publishing helpers, command handling, and map management
- Optional Prometheus-exported metrics for connector health monitoring
Documentation
For detailed documentation, including installation guides, usage examples, configuration reference, and API details, see the Documentation.
To build the documentation locally:
make -C docs/sphinx html
The documentation will be available in docs/sphinx/_build/html/index.html and can be served locally with make -C docs/sphinx serve.
Requirements
- Python 3.10 or later
- InOrbit account (it's free to sign up!)
Setup
There are two ways of installing the inorbit-connector Python package.
-
From PyPi:
pip install inorbit-connector -
From source: clone the repository and install the dependencies:
git clone https://github.com/inorbit-ai/inorbit-connector-python.git
virtualenv venv
. venv/bin/activate
pip install .
See the CONTRIBUTING.md file for information on how to develop the project.
Quick Start
The examples directory contains usage examples of the connector. See examples/README for more information.
A cookiecutter template is available for quickly generating a new connector project. See inorbit-connector-cookiecutter for more information.
Contributing
Any contribution that you make to this repository will be under the MIT license, as dictated by that license.
Please refer to the CONTRIBUTING.md file for information on how to contribute to this project.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file inorbit_connector-3.2.1.tar.gz.
File metadata
- Download URL: inorbit_connector-3.2.1.tar.gz
- Upload date:
- Size: 63.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd8c2dc0e358a9e00371167cbdc339cf1976c26cb6aaaa7a0dca73bfd3a1414c
|
|
| MD5 |
3c6370495507fe8908119f711ef49d26
|
|
| BLAKE2b-256 |
ab39e81a77db6a224a2bc492b59c00b9e8a7478284a5fa042829da8643c74dd7
|
Provenance
The following attestation bundles were made for inorbit_connector-3.2.1.tar.gz:
Publisher:
build-and-publish.yaml on inorbit-ai/inorbit-connector-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
inorbit_connector-3.2.1.tar.gz -
Subject digest:
dd8c2dc0e358a9e00371167cbdc339cf1976c26cb6aaaa7a0dca73bfd3a1414c - Sigstore transparency entry: 2289304882
- Sigstore integration time:
-
Permalink:
inorbit-ai/inorbit-connector-python@0976f9266918164cf1e73ddf164fceb6c1471abb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/inorbit-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-publish.yaml@0976f9266918164cf1e73ddf164fceb6c1471abb -
Trigger Event:
push
-
Statement type:
File details
Details for the file inorbit_connector-3.2.1-py3-none-any.whl.
File metadata
- Download URL: inorbit_connector-3.2.1-py3-none-any.whl
- Upload date:
- Size: 40.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6678624f8d52a2d1caadc97e46003e96418b192923cc3261c13e070e8986ab0d
|
|
| MD5 |
be67e2737f3cf3e0ea657aaae27b0587
|
|
| BLAKE2b-256 |
0ff5587c6b46599050e531752715b9b28b686f56a1ee1128df605016c8ff4f8f
|
Provenance
The following attestation bundles were made for inorbit_connector-3.2.1-py3-none-any.whl:
Publisher:
build-and-publish.yaml on inorbit-ai/inorbit-connector-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
inorbit_connector-3.2.1-py3-none-any.whl -
Subject digest:
6678624f8d52a2d1caadc97e46003e96418b192923cc3261c13e070e8986ab0d - Sigstore transparency entry: 2289304953
- Sigstore integration time:
-
Permalink:
inorbit-ai/inorbit-connector-python@0976f9266918164cf1e73ddf164fceb6c1471abb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/inorbit-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-and-publish.yaml@0976f9266918164cf1e73ddf164fceb6c1471abb -
Trigger Event:
push
-
Statement type:
