Metadata-Version: 2.4
Name: inorbit-connector
Version: 2.2.0
Summary: A Python library for connectors in the InOrbit RobOps ecosystem.
Download-URL: https://github.com/inorbit-ai/inorbit-connector-python/archive/refs/tags/v2.2.0.zip
Author-email: "InOrbit, Inc." <support@inorbit.ai>
Maintainer-email: "InOrbit, Inc." <support@inorbit.ai>
License: MIT License
        
        Copyright 2024 InOrbit, Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://inorbit-ai.github.io/inorbit-connector-python/
Project-URL: Tracker, https://github.com/inorbit-ai/inorbit-connector-python/issues
Project-URL: Contributing, https://github.com/inorbit-ai/inorbit-connector-python/blob/v2.2.0/CONTRIBUTING.md
Project-URL: Code of Conduct, https://github.com/inorbit-ai/inorbit-connector-python/blob/v2.2.0/CODE_OF_CONDUCT.md
Project-URL: Issue Tracker, https://github.com/inorbit-ai/inorbit-connector-python/issues
Project-URL: License, https://github.com/inorbit-ai/inorbit-connector-python/blob/v2.2.0/LICENSE
Project-URL: About, https://www.inorbit.ai/company
Project-URL: Contact, https://www.inorbit.ai/contact
Project-URL: Blog, https://www.inorbit.ai/blog
Project-URL: Twitter, https://twitter.com/InOrbitAI
Project-URL: LinkedIn, https://www.linkedin.com/company/inorbitai
Project-URL: GitHub, https://github.com/inorbit-ai
Project-URL: Website, https://www.inorbit.ai/
Project-URL: Source, https://github.com/inorbit-ai/inorbit-connector-python/tree/v2.2.0
Keywords: inorbit,robops,robotics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: inorbit-edge[video]<3.0,>=2.0
Requires-Dist: pydantic<3.0,>=2.11
Requires-Dist: pytz>=2025.1
Requires-Dist: PyYAML<7.0,>=6.0.2
Requires-Dist: typing_extensions>=4.5.0; python_version < "3.12"
Provides-Extra: dev
Requires-Dist: bump2version~=1.0; extra == "dev"
Requires-Dist: black~=25.9; extra == "dev"
Requires-Dist: coverage~=7.10; extra == "dev"
Requires-Dist: flake8~=7.3; extra == "dev"
Requires-Dist: flake8-pyproject~=1.2; extra == "dev"
Requires-Dist: pytest~=8.4; extra == "dev"
Requires-Dist: pytest-asyncio~=1.2; extra == "dev"
Requires-Dist: setuptools~=80.9; extra == "dev"
Requires-Dist: tox~=4.30; extra == "dev"
Requires-Dist: reuse~=6.2; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx~=8.2; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"
Provides-Extra: colorlog
Requires-Dist: colorlog==6.9.0; extra == "colorlog"
Provides-Extra: system-stats
Requires-Dist: psutil>=7; extra == "system-stats"
Dynamic: download-url
Dynamic: license-file
Dynamic: project-url

<!--
SPDX-FileCopyrightText: 2025 InOrbit, Inc.

SPDX-License-Identifier: MIT
-->

# `inorbit-connector`

![License](https://img.shields.io/badge/License-MIT-yellow.svg) ![PyPI - Package Version](https://img.shields.io/pypi/v/inorbit-connector) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/inorbit-connector)

![Lint and Test](https://github.com/inorbit-ai/inorbit-connector-python/actions/workflows/lint-and-test.yaml/badge.svg) ![Build and Publish](https://github.com/inorbit-ai/inorbit-connector-python/actions/workflows/build-and-publish.yaml/badge.svg) ![Docs](https://github.com/inorbit-ai/inorbit-connector-python/actions/workflows/docs.yaml/badge.svg)

A Python framework for developing _connectors_ for the [InOrbit](https://inorbit.ai/) RobOps ecosystem.

## Overview

This repository contains a Python framework that provides a base structure for developing [InOrbit](https://inorbit.ai/) robot connectors.
Making use of InOrbit's [Edge SDK](https://developer.inorbit.ai/docs#edge-sdk), `inorbit-connector` provides a starting point for the integration of a fleet of robots in InOrbit, unlocking interoperability.

## Documentation

For detailed documentation, including installation guides, usage examples, configuration reference, and API details, see the [Documentation](docs/index.md).

To build the documentation locally:

```bash
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!)](https://control.inorbit.ai)

## Setup

There are two ways of installing the `inorbit-connector` Python package.

1. From [PyPi](https://pypi.org/project/inorbit-connector/): `pip install inorbit-connector`

2. From source: clone the repository and install the dependencies:

```bash
git clone https://github.com/inorbit-ai/inorbit-connector-python.git
virtualenv venv
. venv/bin/activate
pip install .
```

See the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to develop the project.

## Quick Start

The [`examples`](examples) directory contains usage examples of the connector. See [examples/README](examples/README.md) for more information.

## Contributing

Any contribution that you make to this repository will be under the MIT license, as dictated by that [license](https://opensource.org/licenses/MIT).

Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to contribute to this project.

![Powered by InOrbit](assets/inorbit_github_footer.png)
