# RedisROS
A Redis-based pure python alternative to ROS2
[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [About](#about)
---
> **Warning**
> This library is still in development, and has not been properly tested, use at your own risks
---
RedisROS is an event-based publisher/subscriber communication framework, aimed at enabling fast development and prototying of event-driven applications. Those include robotics, simulation, and any other application operating on this ethos. It follows a very similar structure to the well established Robot Operating System (ROS), with an emphasis put on minimal development overhead and fast prototyping.
As such, the development of this library has been done according to the following ethos:
- **A pure-python implementation:** The goal of RedisROS is not performance as much as it is fast and flexible prototyping. Python was as such selected, given its ease of use and accessibility.
- **An interface similar to that of ROS2:** Scripts developed using RedisROS should be portable to ROS2 with minimal modifications if desired (given no RedisROS-specific features are used, more on that later).
- **Minimal development overhead:** RedisROS gets rid of all unnecessary steps when possible. There is no more need for compiling, messages definitions, packages etc.
- **Minimal dependencies:** To further reduce complexity, dependencies are kept to a minimum. The only major dependency being *Redis*, and the *python-redis-lock* library. **ROS is *not* necessary for RedisROS to run**.
- **Modular and expandable:** RedisROS was coded to be easily expanded. New interfaces can easily be setup, allowing for testing new configurations and ideas.
*It should be noted that RedisROS is also capable of communicating with ROS/ROS2. Bridges are under development and will be released soon.*
## Why Redis?
*"Redis is an in-memory data structure store, used as a distributed, in-memory key–value database, cache and message broker, with optional durability."*
Redis solves the issue of cross-process comunication, while ensuring performance and reliability in the exchange of information. It can furthermore be deployed on distibuted architecture, making it an interesting choice for scalability purposes.
# Installation
*Coming soon*
# Usage
With RedisROS, any python class can be made a node capable of communicating with the communication layer. Similarly to ROS2, the class can inherit from RedisROS's node class, which in turn gives it access to all RedisROS methods.
Alternatively a RedisROS node can be created, which can then be passed around, and interfaced with as needs be.
*Coming soon*
## Core endpoints
To allow for emulating all behaviors desired, three core endpoints are necessary:
- The **publisher**: Used to push data to topics
- The **subscriber**: Used to monitor, retreive, and react to data being published on topics
- The **shared variable**: Used to store a single, cross-process value (somewhat similar to ROS's parameters)
All other behaviors can be achieved through combining the above (more in [custom endpoints](#custom-endpoints))
### Publisher
*Coming soon*
### Subscriber
*Coming soon*
### Shared_variable
*Coming soon*
## Custom endpoints
The three core endpoints can be combined to emulate most behaviors. RedisROS makes it easy to build on those to achieve the desired behaviors. Currently, the following custom endpoints are being developed
### Behavior
- **Service:** Allows for request/response pattern
### Bridges
- **ROS publisher:** Bridge endpoint, allowing for sending messages through ROS
- **ROS subscriber:** Bridge endpoint, allowing for sending messages through ROS
# From RedisROS to ROS2
*Coming soon*
# Advanced Topics
*Coming soon*
## Custom endpoints
*Coming soon*
# About
RedisROS was developed as part of a **larger upcoming project**. Stay tunned for more!
Raw data
{
"_id": null,
"home_page": "https://github.com/vguillet/RedisROS",
"name": "RedisROS",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 3.8",
"maintainer_email": "",
"keywords": "ROS,ROS2,event-based,python,redis,robotics",
"author": "Victor Guillet",
"author_email": "victor.guillet@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/7c/47/d14998a9deb2669f6e7a3d12849b0bd604082c611f0bb454a63699df392a/RedisROS-0.0.3.tar.gz",
"platform": null,
"description": "# RedisROS\nA Redis-based pure python alternative to ROS2\n\n[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [About](#about)\n\n---\n> **Warning** \n> This library is still in development, and has not been properly tested, use at your own risks\n---\n\nRedisROS is an event-based publisher/subscriber communication framework, aimed at enabling fast development and prototying of event-driven applications. Those include robotics, simulation, and any other application operating on this ethos. It follows a very similar structure to the well established Robot Operating System (ROS), with an emphasis put on minimal development overhead and fast prototyping.\n\nAs such, the development of this library has been done according to the following ethos:\n\n- **A pure-python implementation:** The goal of RedisROS is not performance as much as it is fast and flexible prototyping. Python was as such selected, given its ease of use and accessibility.\n\n- **An interface similar to that of ROS2:** Scripts developed using RedisROS should be portable to ROS2 with minimal modifications if desired (given no RedisROS-specific features are used, more on that later).\n\n- **Minimal development overhead:** RedisROS gets rid of all unnecessary steps when possible. There is no more need for compiling, messages definitions, packages etc.\n\n- **Minimal dependencies:** To further reduce complexity, dependencies are kept to a minimum. The only major dependency being *Redis*, and the *python-redis-lock* library. **ROS is *not* necessary for RedisROS to run**.\n\n- **Modular and expandable:** RedisROS was coded to be easily expanded. New interfaces can easily be setup, allowing for testing new configurations and ideas.\n\n*It should be noted that RedisROS is also capable of communicating with ROS/ROS2. Bridges are under development and will be released soon.*\n\n## Why Redis?\n*\"Redis is an in-memory data structure store, used as a distributed, in-memory key\u00e2\u20ac\u201cvalue database, cache and message broker, with optional durability.\"*\n\nRedis solves the issue of cross-process comunication, while ensuring performance and reliability in the exchange of information. It can furthermore be deployed on distibuted architecture, making it an interesting choice for scalability purposes.\n\n# Installation\n*Coming soon*\n# Usage\nWith RedisROS, any python class can be made a node capable of communicating with the communication layer. Similarly to ROS2, the class can inherit from RedisROS's node class, which in turn gives it access to all RedisROS methods. \n\nAlternatively a RedisROS node can be created, which can then be passed around, and interfaced with as needs be.\n\n*Coming soon*\n\n## Core endpoints\nTo allow for emulating all behaviors desired, three core endpoints are necessary:\n- The **publisher**: Used to push data to topics\n- The **subscriber**: Used to monitor, retreive, and react to data being published on topics\n- The **shared variable**: Used to store a single, cross-process value (somewhat similar to ROS's parameters)\n\nAll other behaviors can be achieved through combining the above (more in [custom endpoints](#custom-endpoints))\n\n### Publisher\n*Coming soon*\n### Subscriber\n*Coming soon*\n### Shared_variable\n*Coming soon*\n## Custom endpoints\nThe three core endpoints can be combined to emulate most behaviors. RedisROS makes it easy to build on those to achieve the desired behaviors. Currently, the following custom endpoints are being developed\n\n### Behavior\n- **Service:** Allows for request/response pattern\n\n### Bridges\n- **ROS publisher:** Bridge endpoint, allowing for sending messages through ROS\n- **ROS subscriber:** Bridge endpoint, allowing for sending messages through ROS\n\n# From RedisROS to ROS2\n*Coming soon*\n# Advanced Topics\n*Coming soon*\n## Custom endpoints\n*Coming soon*\n# About\nRedisROS was developed as part of a **larger upcoming project**. Stay tunned for more! \n\n\n",
"bugtrack_url": null,
"license": "GNU GPLv3",
"summary": "A redis-based event-based ROS2-like library for python",
"version": "0.0.3",
"split_keywords": [
"ros",
"ros2",
"event-based",
"python",
"redis",
"robotics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "988ac96e0fdf6d3f98342c1c495ebca1de5aefc5959adf252d4fcda2b3549fc6",
"md5": "8d60705db4ed7ed192c30c29550da3a8",
"sha256": "cb4d75c351ea99dff71d97292273a794429323793910d5c38e340e96e4b2a711"
},
"downloads": -1,
"filename": "RedisROS-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d60705db4ed7ed192c30c29550da3a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">= 3.8",
"size": 38396,
"upload_time": "2023-03-19T15:20:33",
"upload_time_iso_8601": "2023-03-19T15:20:33.458591Z",
"url": "https://files.pythonhosted.org/packages/98/8a/c96e0fdf6d3f98342c1c495ebca1de5aefc5959adf252d4fcda2b3549fc6/RedisROS-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c47d14998a9deb2669f6e7a3d12849b0bd604082c611f0bb454a63699df392a",
"md5": "a402a5849021fc2892a78357253eb5e0",
"sha256": "fc93c9a6b52f0f109e10e546631f0e30ccb437dab7ab174970d876acc217e7a0"
},
"downloads": -1,
"filename": "RedisROS-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a402a5849021fc2892a78357253eb5e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3.8",
"size": 30669,
"upload_time": "2023-03-19T15:20:35",
"upload_time_iso_8601": "2023-03-19T15:20:35.502706Z",
"url": "https://files.pythonhosted.org/packages/7c/47/d14998a9deb2669f6e7a3d12849b0bd604082c611f0bb454a63699df392a/RedisROS-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-19 15:20:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "vguillet",
"github_project": "RedisROS",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "redisros"
}
JSON
