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.
Release files for inorbit-connector 3.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| inorbit_connector-3.2.4.tar.gz | 64.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| inorbit_connector-3.2.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 106.1 kB
Release files / inorbit_connector-3.2.4.tar.gz
| Download URL | inorbit_connector-3.2.4.tar.gz |
|---|---|
| Size | 64.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a6587a16c977a3659c6e7f0a44c3a4a5519647353ac8369099946f2d3c97f148
|
|
BLAKE2b-256 checksum How to use checksums |
99352680cc1e729c029a2f810181bbabe62e5a6e857b8eed64c55d28b1fec230
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / inorbit_connector-3.2.4-py3-none-any.whl
| Download URL | inorbit_connector-3.2.4-py3-none-any.whl |
|---|---|
| Size | 41.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d2e63ba2c3faf7ec1467f1b6b684eff161caeffbf63a4d38aca2ccc585c921f3
|
|
BLAKE2b-256 checksum How to use checksums |
08df27b371c71b971120c00cc347ccf9b3d7f71010ea3123d6f44b6ff3aa3da4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency log
