inorbit-connector


Nameinorbit-connector JSON
Version 1.2.1 PyPI version JSON
download
home_pagehttps://github.com/inorbit-ai/inorbit-connector-python
SummaryA Python library for connectors in the InOrbit RobOps ecosystem.
upload_time2025-07-25 13:45:04
maintainerRussell Toris
docs_urlNone
authorInOrbit, Inc.
requires_python<3.13,>=3.10
licenseMIT
keywords inorbit robops robotics
VCS
bugtrack_url
requirements inorbit_edge pydantic pytz PyYAML
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `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) 

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.

## 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 -r requirements.txt
```

## Quick Start

The [`examples`](examples) directory contains usage examples of the connector. See [scripts/README](scripts/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)

            

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/ae/72/87e2afef723b51785728c5ac7bc91568431c700256ea62a1bd67f15b24d7/inorbit_connector-1.2.1.tar.gz",
    "platform": "Linux",
    "description": "# `inorbit-connector`\n\n![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)\n\n![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) \n\nA Python framework for developing _connectors_ for the [InOrbit](https://inorbit.ai/) RobOps ecosystem.\n\n## Overview\n\nThis repository contains a Python framework that provides a base structure for developing [InOrbit](https://inorbit.ai/) robot connectors.\nMaking 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.\n\n## Requirements\n\n- Python 3.10 or later\n- InOrbit account [(it's free to sign up!)](https://control.inorbit.ai)\n\n## Setup\n\nThere are two ways of installing the `inorbit-connector` Python package.\n\n1. From [PyPi](https://pypi.org/project/inorbit-connector/): `pip install inorbit-connector`\n\n2. From source: clone the repository and install the dependencies:\n\n```bash\ngit clone https://github.com/inorbit-ai/inorbit-connector-python.git\nvirtualenv venv\n. venv/bin/activate\npip install -r requirements.txt\n```\n\n## Quick Start\n\nThe [`examples`](examples) directory contains usage examples of the connector. See [scripts/README](scripts/README.md) for more information.\n\n## Contributing\n\nAny contribution that you make to this repository will be under the MIT license, as dictated by that [license](https://opensource.org/licenses/MIT).\n\nPlease refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information on how to contribute to this project.\n\n![Powered by InOrbit](assets/inorbit_github_footer.png)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python library for connectors in the InOrbit RobOps ecosystem.",
    "version": "1.2.1",
    "project_urls": {
        "About": "https://www.inorbit.ai/company",
        "Blog": "https://www.inorbit.ai/blog",
        "Changelog": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v1.2.1/CHANGELOG.md",
        "Code of Conduct": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v1.2.1/CODE_OF_CONDUCT.md",
        "Contact": "https://www.inorbit.ai/contact",
        "Contributing": "https://github.com/inorbit-ai/inorbit-connector-python/blob/v1.2.1/CONTRIBUTING.md",
        "Download": "https://github.com/inorbit-ai/inorbit-connector-python/archive/refs/tags/1.2.1.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/v1.2.1/LICENSE",
        "LinkedIn": "https://www.linkedin.com/company/inorbitai",
        "Source": "https://github.com/inorbit-ai/inorbit-connector-python/tree/v1.2.1",
        "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": null,
            "digests": {
                "blake2b_256": "6a80cbac609381636f4ca5aa7ecde5af0c8175943a4ba3a9bc05ba7094d68ae9",
                "md5": "9c2ec40755bf44367ff5d890222892b7",
                "sha256": "4455f5b1cd48b8ff80f1d7d74c1de01e970aaf3a6e937549b1b8f2a02961cc91"
            },
            "downloads": -1,
            "filename": "inorbit_connector-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c2ec40755bf44367ff5d890222892b7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.10",
            "size": 14677,
            "upload_time": "2025-07-25T13:45:02",
            "upload_time_iso_8601": "2025-07-25T13:45:02.941945Z",
            "url": "https://files.pythonhosted.org/packages/6a/80/cbac609381636f4ca5aa7ecde5af0c8175943a4ba3a9bc05ba7094d68ae9/inorbit_connector-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ae7287e2afef723b51785728c5ac7bc91568431c700256ea62a1bd67f15b24d7",
                "md5": "161045cbfe26599e93e216b502e00d49",
                "sha256": "71d86fac0193a1efdd987ea7fe651f4b77d0bede73a6dba892bb3d410e88fb0b"
            },
            "downloads": -1,
            "filename": "inorbit_connector-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "161045cbfe26599e93e216b502e00d49",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.10",
            "size": 20181,
            "upload_time": "2025-07-25T13:45:04",
            "upload_time_iso_8601": "2025-07-25T13:45:04.327953Z",
            "url": "https://files.pythonhosted.org/packages/ae/72/87e2afef723b51785728c5ac7bc91568431c700256ea62a1bd67f15b24d7/inorbit_connector-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-25 13:45:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "inorbit-ai",
    "github_project": "inorbit-connector-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "inorbit_edge",
            "specs": [
                [
                    "<",
                    "2.0"
                ],
                [
                    ">=",
                    "1.20.1"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "2.6"
                ],
                [
                    "<",
                    "3.0"
                ]
            ]
        },
        {
            "name": "pytz",
            "specs": [
                [
                    ">=",
                    "2024.1"
                ]
            ]
        },
        {
            "name": "PyYAML",
            "specs": [
                [
                    "<",
                    "7.0"
                ],
                [
                    ">=",
                    "6.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "inorbit-connector"
}
        
Elapsed time: 2.50981s