| Name | lotusrpc JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | None |
| Summary | A code generator for remote procedure calls on embedded systems |
| upload_time | 2025-01-20 21:19:33 |
| maintainer | None |
| docs_url | None |
| author | T Zijnge |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022 tzijnge Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
code generation
embedded systems
c++
rpc
remote procedure call
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://sonarcloud.io/summary/new_code?id=tzijnge_LotusRpc)
[](https://sonarcloud.io/summary/new_code?id=tzijnge_LotusRpc)
[](https://github.com/psf/black)
# LotusRPC 🌼
> **_WARNING:_** This project is work in progress
LotusRPC is an RPC framework for embedded systems based on [ETL](https://github.com/ETLCPP/etl). It generates C++ code with no dynamic memory allocations, no exceptions, no RTTI, etc. Code generator and client side CLI application in a simple Python package.
## Installation
Install from [PyPI](https://pypi.org/project/lotusrpc/) with ```pip install lotusrpc```
## Basic usage
Installing the Python package installs the `lrpcg` tool on your system. This is the LotusRPC generator. It also installs the `lrpcc` tool on your system. This is the LotusRpc CLI client.
Your RPC interface is specified in a YAML file
File name: _example.lrpc.yaml_
``` yaml
services:
- name: "battery"
functions:
- name: "get"
params:
- name: "option"
type: "@VoltageScales"
returns:
- name: "voltage"
type: double
enums:
- name: "VoltageScales"
fields:
name: "microvolts"
name: "millivolts"
name: "volts"
```
Generate server side code by simply running this command
```lrpcg example.lrpc.yaml -o output-dir```
Give the generated code a meaningful implementation and hook it up to a transport layer. Flash your embedded device. Then use `lrpcc` to communicate with your device and print the result to the console
```lrpcc battery get microvolts```
## Documentation
Please find more detailed information [here](https://tzijnge.github.io/LotusRpc/)
Raw data
{
"_id": null,
"home_page": null,
"name": "lotusrpc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "code generation, embedded systems, C++, RPC, remote procedure call",
"author": "T Zijnge",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/55/731f41e8a3cc59999823a0b6ffb16e58668b27140bd5acc28820afb5d690/lotusrpc-0.9.0.tar.gz",
"platform": null,
"description": "\n\n[](https://sonarcloud.io/summary/new_code?id=tzijnge_LotusRpc)\n\n[](https://sonarcloud.io/summary/new_code?id=tzijnge_LotusRpc)\n\n[](https://github.com/psf/black)\n\n# LotusRPC \ud83c\udf3c\n> **_WARNING:_** This project is work in progress\n\nLotusRPC is an RPC framework for embedded systems based on [ETL](https://github.com/ETLCPP/etl). It generates C++ code with no dynamic memory allocations, no exceptions, no RTTI, etc. Code generator and client side CLI application in a simple Python package.\n\n## Installation\nInstall from [PyPI](https://pypi.org/project/lotusrpc/) with ```pip install lotusrpc```\n\n## Basic usage\nInstalling the Python package installs the `lrpcg` tool on your system. This is the LotusRPC generator. It also installs the `lrpcc` tool on your system. This is the LotusRpc CLI client.\n\nYour RPC interface is specified in a YAML file\n\nFile name: _example.lrpc.yaml_\n``` yaml\nservices:\n - name: \"battery\"\n functions:\n - name: \"get\"\n params:\n - name: \"option\"\n type: \"@VoltageScales\"\n returns:\n - name: \"voltage\"\n type: double\nenums:\n - name: \"VoltageScales\"\n fields:\n name: \"microvolts\"\n name: \"millivolts\"\n name: \"volts\"\n```\n\nGenerate server side code by simply running this command\n\n```lrpcg example.lrpc.yaml -o output-dir```\n\nGive the generated code a meaningful implementation and hook it up to a transport layer. Flash your embedded device. Then use `lrpcc` to communicate with your device and print the result to the console\n\n```lrpcc battery get microvolts```\n\n## Documentation\nPlease find more detailed information [here](https://tzijnge.github.io/LotusRpc/)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 tzijnge Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A code generator for remote procedure calls on embedded systems",
"version": "0.9.0",
"project_urls": {
"Bug Tracker": "https://github.com/tzijnge/LotusRpc/issues",
"Documentation": "https://tzijnge.github.io/LotusRpc/",
"Source Code": "https://github.com/tzijnge/LotusRpc",
"homepage": "https://github.com/tzijnge/LotusRpc"
},
"split_keywords": [
"code generation",
" embedded systems",
" c++",
" rpc",
" remote procedure call"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a511f96ccbe99ffa987c7411030f6d858501f73f059071e37876e6a34e9d55a",
"md5": "4a20dd5983298c4edb68882a7203c32b",
"sha256": "7c4830991e54f0b0cf9ed24461439afe160792f4f42b48abbcfc7e2ee7625bca"
},
"downloads": -1,
"filename": "lotusrpc-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a20dd5983298c4edb68882a7203c32b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40071,
"upload_time": "2025-01-20T21:19:30",
"upload_time_iso_8601": "2025-01-20T21:19:30.685606Z",
"url": "https://files.pythonhosted.org/packages/5a/51/1f96ccbe99ffa987c7411030f6d858501f73f059071e37876e6a34e9d55a/lotusrpc-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3255731f41e8a3cc59999823a0b6ffb16e58668b27140bd5acc28820afb5d690",
"md5": "225ed21285bce2b35b0b6342f6430038",
"sha256": "dc5822450414c6a520a7e56d874b019a44c007ca71fe06d4e565e496ae0bef94"
},
"downloads": -1,
"filename": "lotusrpc-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "225ed21285bce2b35b0b6342f6430038",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 782409,
"upload_time": "2025-01-20T21:19:33",
"upload_time_iso_8601": "2025-01-20T21:19:33.078799Z",
"url": "https://files.pythonhosted.org/packages/32/55/731f41e8a3cc59999823a0b6ffb16e58668b27140bd5acc28820afb5d690/lotusrpc-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-20 21:19:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tzijnge",
"github_project": "LotusRpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lotusrpc"
}
