qrkey

Name	qrkey JSON
Version	0.8.0 JSON
	download
home_page	None
Summary	Swarm robotics deployments made easy.
upload_time	2024-10-18 08:42:37
maintainer	None
docs_url	None
author	None
requires_python	>=3.11
license	None
keywords	robotics swarm ux
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Qrkey

[![PyPI - Version](https://img.shields.io/pypi/v/qrkey.svg)](https://pypi.org/project/qrkey)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qrkey.svg)](https://pypi.org/project/qrkey)
[![NPM - Version](https://img.shields.io/npm/v/qrkey.svg)](https://npmjs.org/package/qrkey)

<p align="center">
  <img src="qrkey.png" width="328"/>
</p>

## Summary

Qrkey is a library implementing a protocol designed to facilitate the
deployment of robots swarm.
The protocol relies on [MQTT](https://en.wikipedia.org/wiki/MQTT) so that a
Qrkey server is reachable even with a private IP address.
Access to the swarm is managed by a QR code based authentication scheme.

## Installation

- Python server library:

```console
pip install qrkey
```

- Node client library:

```console
npm i qrkey
```

## License

`qrkey` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qrkey",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "robotics, swarm, ux",
    "author": null,
    "author_email": "Alexandre Abadie <alexandre.abadie@inria.fr>",
    "download_url": "https://files.pythonhosted.org/packages/f5/bc/60d4c0faa2bf404e82e44ea0e501823c99695276cdf4e167718efc581188/qrkey-0.8.0.tar.gz",
    "platform": null,
    "description": "# Qrkey\n\n[![PyPI - Version](https://img.shields.io/pypi/v/qrkey.svg)](https://pypi.org/project/qrkey)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qrkey.svg)](https://pypi.org/project/qrkey)\n[![NPM - Version](https://img.shields.io/npm/v/qrkey.svg)](https://npmjs.org/package/qrkey)\n\n<p align=\"center\">\n  <img src=\"qrkey.png\" width=\"328\"/>\n</p>\n\n## Summary\n\nQrkey is a library implementing a protocol designed to facilitate the\ndeployment of robots swarm.\nThe protocol relies on [MQTT](https://en.wikipedia.org/wiki/MQTT) so that a\nQrkey server is reachable even with a private IP address.\nAccess to the swarm is managed by a QR code based authentication scheme.\n\n## Installation\n\n- Python server library:\n\n```console\npip install qrkey\n```\n\n- Node client library:\n\n```console\nnpm i qrkey\n```\n\n## License\n\n`qrkey` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Swarm robotics deployments made easy.",
    "version": "0.8.0",
    "project_urls": {
        "Documentation": "https://github.com/DotBots/qrkey#readme",
        "Issues": "https://github.com/DotBots/qrkey/issues",
        "Source": "https://github.com/DotBots/qrkey"
    },
    "split_keywords": [
        "robotics",
        " swarm",
        " ux"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0af969540fd1d9da1b9ead0384356a4edadbbb12cb561c34fc8b0f2cbf24423f",
                "md5": "f7364e87e8a12a7e5b960888a0176b1c",
                "sha256": "203994243417e7c0cbee0f9f7fb4701392f76d01c8f9ee85ef129671122c1b85"
            },
            "downloads": -1,
            "filename": "qrkey-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f7364e87e8a12a7e5b960888a0176b1c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 912496,
            "upload_time": "2024-10-18T08:42:36",
            "upload_time_iso_8601": "2024-10-18T08:42:36.020800Z",
            "url": "https://files.pythonhosted.org/packages/0a/f9/69540fd1d9da1b9ead0384356a4edadbbb12cb561c34fc8b0f2cbf24423f/qrkey-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f5bc60d4c0faa2bf404e82e44ea0e501823c99695276cdf4e167718efc581188",
                "md5": "28005bf0c938c1bf335738f436dfcd56",
                "sha256": "9e2ac56a6cd1b4bdb6da2dfa985d1e4772643a70603b426fd69f7cd36b2d4559"
            },
            "downloads": -1,
            "filename": "qrkey-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "28005bf0c938c1bf335738f436dfcd56",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 901933,
            "upload_time": "2024-10-18T08:42:37",
            "upload_time_iso_8601": "2024-10-18T08:42:37.707894Z",
            "url": "https://files.pythonhosted.org/packages/f5/bc/60d4c0faa2bf404e82e44ea0e501823c99695276cdf4e167718efc581188/qrkey-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-18 08:42:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DotBots",
    "github_project": "qrkey#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "qrkey"
}