Metadata-Version: 2.1
Name: inorbit-connector
Version: 0.2.1
Summary: A Python library for connectors in the InOrbit RobOps ecosystem.
Home-page: https://github.com/inorbit-ai/inorbit-connector-python
Download-URL: https://github.com/inorbit-ai/inorbit-connector-python/archive/refs/tags/0.2.1.zip
Author: InOrbit, Inc.
Author-email: support@inorbit.ai
Maintainer: Russell Toris
Maintainer-email: russell@inorbit.ai
License: MIT
Project-URL: CI/CD, https://inorbit.teamcity.com/project/Engineering_Development_DeveloperPortal_InorbitConnectorPython
Project-URL: Tracker, https://github.com/inorbit-ai/inorbit-connector-python/issues
Project-URL: Contributing, https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.1/CONTRIBUTING.md
Project-URL: Code of Conduct, https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.1/CODE_OF_CONDUCT.md
Project-URL: Changelog, https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.1/CHANGELOG.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/v0.2.1/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/v0.2.1
Keywords: inorbit,robops,robotics
Platform: Linux
Platform: Windows
Platform: macOS
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
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: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10, <3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: inorbit-edge[video]<2.0,>=1.15.1
Requires-Dist: pydantic<3.0,>=2.6
Requires-Dist: pytz>=2024.1
Requires-Dist: PyYAML<7.0,>=6.0

# inorbit-connector-python
A Python library for developing connectors the InOrbit RobOps ecosystem.


|   OS    |                                                                                                                                                                            Python 3.10                                                                                                                                                                            |                                                                                                                                                                            Python 3.11                                                                                                                                                                            |                                                                                                                                                                            Python 3.12                                                                                                                                                                            |
|:-------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|  Linux  |   [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython310QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython310QualityCheck?branch=%3Cdefault%3E&mode=builds)   |   [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython311QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython311QualityCheck?branch=%3Cdefault%3E&mode=builds)   |   [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython312QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_LinuxPython312QualityCheck?branch=%3Cdefault%3E&mode=builds)   |
|  MacOS  |     [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython310QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython310QualityCheck?branch=%3Cdefault%3E&mode=builds)     |     [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython311QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython311QualityCheck?branch=%3Cdefault%3E&mode=builds)     |     [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython312QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_MacPython312QualityCheck?branch=%3Cdefault%3E&mode=builds)     |
| Windows | [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython310QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython310QualityCheck?branch=%3Cdefault%3E&mode=builds) | [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython311QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython311QualityCheck?branch=%3Cdefault%3E&mode=builds) | [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython312QualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_WindowsPython312QualityCheck?branch=%3Cdefault%3E&mode=builds) |
| Qodana  |      [![TeamCity](https://inorbit.teamcity.com/app/rest/builds/buildType:id:Engineering_Development_DeveloperPortal_InorbitConnectorPython_QodanaLinuxQualityCheck/statusIcon.svg)](https://inorbit.teamcity.com/buildConfiguration/Engineering_Development_DeveloperPortal_InorbitConnectorPython_QodanaLinuxQualityCheck?branch=%3Cdefault%3E&mode=builds)      |                                                                                                                                                                                --                                                                                                                                                                                 |                                                                                                                                                                                --                                                                                                                                                                                 |

## Overview

This repository contains a Python library for creating [InOrbit](https://inorbit.ai/) robot connectors.
Making use of InOrbit's [Edge SDK](https://developer.inorbit.ai/docs#edge-sdk), the library allows the integration of
your fleet of robots in InOrbit, unlocking interoperability.

## Requirements

- Python 3.10 or later
- InOrbit account [(it's free to sign up!)](https://control.inorbit.ai)
## Setup

There are two ways for installing the connector Python package.

1. From PyPi: `pip install inorbit-connector-python`

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

```bash
cd instock_connector/
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt
```

## Getting Started

See [scripts/README](scripts/README.md) for usage of an example connector.
