inorbit-connector


Nameinorbit-connector JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/inorbit-ai/inorbit-connector-python
SummaryA Python library for connectors in the InOrbit RobOps ecosystem.
upload_time2024-11-11 15:25:35
maintainerRussell Toris
docs_urlNone
authorInOrbit, Inc.
requires_python<3.13,>=3.10
licenseMIT
keywords inorbit robops robotics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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](https://www.jetbrains.com/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`

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.13,>=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/4d/03/a8f3c6375c864ee09d285e7a641df1f97f19e190c8356944fad9f39dbeff/inorbit_connector-0.3.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                                                                                                                                                                            |                                                                                                                                                                            Python 3.12                                                                                                                                                                            |\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)   |   [![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)   |\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)     |     [![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)     |\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) | [![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) |\n| [Qodana](https://www.jetbrains.com/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`\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.3.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.3.0/CHANGELOG.md",
        "Code of Conduct": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.3.0/CODE_OF_CONDUCT.md",
        "Contact": "https://www.inorbit.ai/contact",
        "Contributing": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v0.3.0/CONTRIBUTING.md",
        "Download": "https://github.com/inorbit-ai/inorbit-connector-python/archive/refs/tags/0.3.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.3.0/LICENSE",
        "LinkedIn": "https://www.linkedin.com/company/inorbitai",
        "Source": "https://github.com/inorbit-ai/inorbit-connector-python/tree/v0.3.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": "c267866771f68e8a4f436e6361d81c0ebb10b436bde8b677a171ea7fc78df0a3",
                "md5": "b1ea58044ba1e704497e024306e534f1",
                "sha256": "66167c521c091f9c7ab6382b655256b94b7bce0dc127493ecd0009e725527652"
            },
            "downloads": -1,
            "filename": "inorbit_connector-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1ea58044ba1e704497e024306e534f1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.10",
            "size": 10257,
            "upload_time": "2024-11-11T15:25:33",
            "upload_time_iso_8601": "2024-11-11T15:25:33.750637Z",
            "url": "https://files.pythonhosted.org/packages/c2/67/866771f68e8a4f436e6361d81c0ebb10b436bde8b677a171ea7fc78df0a3/inorbit_connector-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d03a8f3c6375c864ee09d285e7a641df1f97f19e190c8356944fad9f39dbeff",
                "md5": "c910dfeccf784c33ec8d43d3c1dbcf8d",
                "sha256": "bced0e8c44e391d6d5ad61a5eaf27215d50e6d0f7223c7c458cf77c293f1ad2c"
            },
            "downloads": -1,
            "filename": "inorbit_connector-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c910dfeccf784c33ec8d43d3c1dbcf8d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.10",
            "size": 14743,
            "upload_time": "2024-11-11T15:25:35",
            "upload_time_iso_8601": "2024-11-11T15:25:35.372712Z",
            "url": "https://files.pythonhosted.org/packages/4d/03/a8f3c6375c864ee09d285e7a641df1f97f19e190c8356944fad9f39dbeff/inorbit_connector-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-11 15:25:35",
    "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": [],
    "tox": true,
    "lcname": "inorbit-connector"
}
        
Elapsed time: 0.54257s