# inorbit-connector-python
A Python library for developing connectors the InOrbit RobOps ecosystem.
| OS | Python 3.10 | Python 3.11 |
|:-------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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) |
| 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) |
| 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) |
| 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/inorbit-ai/inorbit-connector-python",
"name": "inorbit-connector",
"maintainer": "Russell Toris",
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": "russell@inorbit.ai",
"keywords": "inorbit, robops, robotics",
"author": "InOrbit, Inc.",
"author_email": "support@inorbit.ai",
"download_url": "https://files.pythonhosted.org/packages/7b/a9/4ed952d366bb933db90f643bc176463440dc1ba3e42cc86137e6e4338c83/inorbit_connector-0.2.0.tar.gz",
"platform": "Linux",
"description": "# inorbit-connector-python\nA Python library for developing connectors the InOrbit RobOps ecosystem.\n\n\n| OS | Python 3.10 | Python 3.11 |\n|:-------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|\n| 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) |\n| 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) |\n| 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) |\n| 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) | -- |\n\n## Overview\n\nThis repository contains a Python library for creating [InOrbit](https://inorbit.ai/) robot connectors.\nMaking use of InOrbit's [Edge SDK](https://developer.inorbit.ai/docs#edge-sdk), the library allows the integration of\nyour fleet of robots in InOrbit, unlocking interoperability.\n\n## Requirements\n\n- Python 3.10 or later\n- InOrbit account [(it's free to sign up!)](https://control.inorbit.ai)\n## Setup\n\nThere are two ways for installing the connector Python package.\n\n1. From PyPi: `pip install inorbit-connector-python`\n\n2. From source: clone the repository and install the dependencies:\n\n```bash\ncd instock_connector/\nvirtualenv .venv\n. .venv/bin/activate\npip install -r requirements.txt\n```\n\n## Getting Started\n\nSee [scripts/README](scripts/README.md) for usage of an example connector.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for connectors in the InOrbit RobOps ecosystem.",
"version": "0.2.0",
"project_urls": {
"About": "https://www.inorbit.ai/company",
"Blog": "https://www.inorbit.ai/blog",
"CI/CD": "https://inorbit.teamcity.com/project/Engineering_Development_DeveloperPortal_InorbitConnectorPython",
"Changelog": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.0/CHANGELOG.md",
"Code of Conduct": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.0/CODE_OF_CONDUCT.md",
"Contact": "https://www.inorbit.ai/contact",
"Contributing": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.0/CONTRIBUTING.md",
"Download": "https://github.com/inorbit-ai/inorbit-connector-python/archive/refs/tags/0.2.0.zip",
"GitHub": "https://github.com/inorbit-ai",
"Homepage": "https://github.com/inorbit-ai/inorbit-connector-python",
"Issue Tracker": "https://github.com/inorbit-ai/inorbit-connector-python/issues",
"License": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.2.0/LICENSE",
"LinkedIn": "https://www.linkedin.com/company/inorbitai",
"Source": "https://github.com/inorbit-ai/inorbit-connector-python/tree/v0.2.0",
"Tracker": "https://github.com/inorbit-ai/inorbit-connector-python/issues",
"Twitter": "https://twitter.com/InOrbitAI",
"Website": "https://www.inorbit.ai/"
},
"split_keywords": [
"inorbit",
" robops",
" robotics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c878de85c4b17b6ec73d5fafd77536efcb40751409bb906d315a98775d710f1d",
"md5": "98a2c9705b9a5d55e032dba9a3bbc21c",
"sha256": "2b1b2bb247d6b488ad4078a9884dd004d3f203e835dd8b7f274458d1d330b82d"
},
"downloads": -1,
"filename": "inorbit_connector-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98a2c9705b9a5d55e032dba9a3bbc21c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 8325,
"upload_time": "2024-06-18T18:55:16",
"upload_time_iso_8601": "2024-06-18T18:55:16.521266Z",
"url": "https://files.pythonhosted.org/packages/c8/78/de85c4b17b6ec73d5fafd77536efcb40751409bb906d315a98775d710f1d/inorbit_connector-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ba94ed952d366bb933db90f643bc176463440dc1ba3e42cc86137e6e4338c83",
"md5": "911ffa44be77e7b4f46fce14bff4436e",
"sha256": "ecc26c986eb356a354a0d5ed4b7ca1f2205943615eb997fb50945e4248784d2d"
},
"downloads": -1,
"filename": "inorbit_connector-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "911ffa44be77e7b4f46fce14bff4436e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 11879,
"upload_time": "2024-06-18T18:55:17",
"upload_time_iso_8601": "2024-06-18T18:55:17.927243Z",
"url": "https://files.pythonhosted.org/packages/7b/a9/4ed952d366bb933db90f643bc176463440dc1ba3e42cc86137e6e4338c83/inorbit_connector-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 18:55:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inorbit-ai",
"github_project": "inorbit-connector-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "inorbit-edge",
"specs": [
[
"<",
"2.0"
],
[
">=",
"1.15.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"<",
"3.0"
],
[
">=",
"2.6"
]
]
},
{
"name": "pytz",
"specs": [
[
">=",
"2024.1"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"<",
"7.0"
],
[
">=",
"6.0"
]
]
}
],
"tox": true,
"lcname": "inorbit-connector"
}