# Generate RPC modules
<img align="right" src="https://raw.githubusercontent.com/vroncevic/gen_rpc/dev/docs/gen_rpc_logo.png" width="25%">
**gen_rpc** is tool for generation of RPC modules.
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_python_checker.yml) [](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_package.yml) [](https://github.com/vroncevic/gen_rpc/issues) [](https://github.com/vroncevic/gen_rpc/graphs/contributors)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using setuptools](#install-using-setuptools)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Generation flow of RPC modules](#generation-flow-of-rpc-modules)
- [RPC System](#rpc-system)
- [RPC Mapper](#rpc-mapper)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Copyright and Licence](#copyright-and-licence)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
### Installation
Used next development environment
[](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_python3_build.yml)
Currently there are four ways to install framework
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
Python is located at **[pypi.org](https://pypi.org/project/gen_rpc/)**.
You can install by using pip
```bash
#python3
pip3 install gen_rpc
```
##### Install using build
Navigate to **[release page](https://github.com/vroncevic/gen_rpc/releases)** download and extract release archive.
To install **gen-rpc** run
```bash
tar xvzf gen-rpc-x.y.z.tar.gz
cd gen-rpc-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build -s --no-isolation --wheel
pip3 install dist/gen-rpc-x.y.z-py3-none-any.whl
rm -f get-pip.py
```
##### Install using py setup
Navigate to release **[page](https://github.com/vroncevic/gen_rpc/releases/)** download and extract release archive.
To install **gen_rpc** type the following
```bash
tar xvzf gen_rpc-x.y.z.tar.gz
cd gen_rpc-x.y.z/
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_data
python3 setup.py install_egg_info
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_rpc** requires next modules and libraries
* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_rpc)
### Generation flow of RPC modules
Base flow of generation process
### RPC System
```bash
1. Client encodes data through XDR Filter
2. Client passes XDR encoded data across network to remote host
3. Server decodes data through XDR Filter
4. Server encodes functional call result through XDR Filter
5. Server pass XDR encoded data across network back to Client
6. Client decodes RPC result through XDR Filter and continues processing
```
### RPC Mapper
### Tool structure
**gen_rpc** is based on OOP.
Generator structure
```bash
gen_rpc/
├── conf/
│ ├── gen_rpc.cfg
│ ├── gen_rpc.logo
│ ├── gen_rpc_util.cfg
│ ├── project.yaml
│ └── template/
│ ├── rpc_client.template
│ ├── rpc_server.template
│ └── rpc_square.template
├── __init__.py
├── log/
│ └── gen_rpc.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
├── py.typed
└── run/
└── gen_rpc_run.py
6 directories, 14 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_rpc/__init__.py` | 71 | 12 | 83% |
| `gen_rpc/pro/__init__.py` | 59 | 2 | 97% |
| `gen_rpc/pro/read_template.py` | 53 | 2 | 96% |
| `gen_rpc/pro/write_template.py` | 60 | 5 | 92% |
| **Total** | 243 | 21 | 91% |
### Docs
[](https://gen-rpc.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [gen_rpc.readthedocs.io](https://gen-rpc.readthedocs.io/en/latest/)
* [rpc mechanism](overview.md)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to gen_rpc](CONTRIBUTING.md)
### Copyright and Licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2019 - 2024 by [vroncevic.github.io/gen_rpc](https://vroncevic.github.io/gen_rpc)
**gen_rpc** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://psfmember.org/index.php?q=civicrm/contribute/transact&reset=1&id=2)
Raw data
{
"_id": null,
"home_page": "https://vroncevic.github.io/gen_rpc",
"name": "gen-rpc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Unix, Linux, Development, RPC, Modules",
"author": "Vladimir Roncevic",
"author_email": "elektron.ronca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/7a/f4fb3a4dd114bbed926e11e4e490a4b11a650e7ad95d8953073c750b58cd/gen_rpc-1.0.3.tar.gz",
"platform": "POSIX",
"description": "# Generate RPC modules\n\n<img align=\"right\" src=\"https://raw.githubusercontent.com/vroncevic/gen_rpc/dev/docs/gen_rpc_logo.png\" width=\"25%\">\n\n**gen_rpc** is tool for generation of RPC modules.\n\nDeveloped in **[python](https://www.python.org/)** code.\n\nThe README is used to introduce the modules and provide instructions on\nhow to install the modules, any machine dependencies it may have and any\nother information that should be provided before the modules are installed.\n\n[](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_python_checker.yml) [](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_package.yml) [](https://github.com/vroncevic/gen_rpc/issues) [](https://github.com/vroncevic/gen_rpc/graphs/contributors)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n - [Install using pip](#install-using-pip)\n - [Install using setuptools](#install-using-setuptools)\n - [Install using docker](#install-using-docker)\n- [Dependencies](#dependencies)\n- [Generation flow of RPC modules](#generation-flow-of-rpc-modules)\n- [RPC System](#rpc-system)\n- [RPC Mapper](#rpc-mapper)\n- [Tool structure](#tool-structure)\n- [Docs](#docs)\n- [Copyright and Licence](#copyright-and-licence)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n### Installation\n\nUsed next development environment\n\n\n\n[](https://github.com/vroncevic/gen_rpc/actions/workflows/gen_rpc_python3_build.yml)\n\nCurrently there are four ways to install framework\n* Install process based on using pip mechanism\n* Install process based on build mechanism\n* Install process based on setup.py mechanism\n* Install process based on docker mechanism\n\n##### Install using pip\n\nPython is located at **[pypi.org](https://pypi.org/project/gen_rpc/)**.\n\nYou can install by using pip\n\n```bash\n#python3\npip3 install gen_rpc\n```\n\n##### Install using build\n\nNavigate to **[release page](https://github.com/vroncevic/gen_rpc/releases)** download and extract release archive.\n\nTo install **gen-rpc** run\n\n```bash\ntar xvzf gen-rpc-x.y.z.tar.gz\ncd gen-rpc-x.y.z\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py \npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 -m build -s --no-isolation --wheel\npip3 install dist/gen-rpc-x.y.z-py3-none-any.whl\nrm -f get-pip.py\n```\n\n##### Install using py setup\n\nNavigate to release **[page](https://github.com/vroncevic/gen_rpc/releases/)** download and extract release archive.\n\nTo install **gen_rpc** type the following\n\n```bash\ntar xvzf gen_rpc-x.y.z.tar.gz\ncd gen_rpc-x.y.z/\n# python3\npip3 install -r requirements.txt\npython3 setup.py install_lib\npython3 setup.py install_data\npython3 setup.py install_egg_info\n```\n\n##### Install using docker\n\nYou can use Dockerfile to create image/container.\n\n### Dependencies\n\n**gen_rpc** requires next modules and libraries\n\n* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_rpc)\n\n### Generation flow of RPC modules\n\nBase flow of generation process\n\n\n\n### RPC System\n\n\n```bash\n1. Client encodes data through XDR Filter\n2. Client passes XDR encoded data across network to remote host\n3. Server decodes data through XDR Filter\n4. Server encodes functional call result through XDR Filter\n5. Server pass XDR encoded data across network back to Client\n6. Client decodes RPC result through XDR Filter and continues processing\n```\n\n### RPC Mapper\n\n\n### Tool structure\n\n**gen_rpc** is based on OOP.\n\nGenerator structure\n\n```bash\n gen_rpc/\n \u251c\u2500\u2500 conf/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_rpc.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_rpc.logo\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_rpc_util.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 project.yaml\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 template/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 rpc_client.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 rpc_server.template\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 rpc_square.template\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 log/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 gen_rpc.log\n \u251c\u2500\u2500 pro/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 read_template.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 write_template.py\n \u251c\u2500\u2500 py.typed\n \u2514\u2500\u2500 run/\n \u2514\u2500\u2500 gen_rpc_run.py\n\n 6 directories, 14 files\n```\n\n### Code coverage\n\n| Name | Stmts | Miss | Cover |\n|------|-------|------|-------|\n| `gen_rpc/__init__.py` | 71 | 12 | 83% |\n| `gen_rpc/pro/__init__.py` | 59 | 2 | 97% |\n| `gen_rpc/pro/read_template.py` | 53 | 2 | 96% |\n| `gen_rpc/pro/write_template.py` | 60 | 5 | 92% |\n| **Total** | 243 | 21 | 91% |\n\n### Docs\n\n[](https://gen-rpc.readthedocs.io/en/latest/?badge=latest)\n\nMore documentation and info at\n* [gen_rpc.readthedocs.io](https://gen-rpc.readthedocs.io/en/latest/)\n* [rpc mechanism](overview.md)\n* [www.python.org](https://www.python.org/)\n\n### Contributing\n\n[Contributing to gen_rpc](CONTRIBUTING.md)\n\n### Copyright and Licence\n\n[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)\n\nCopyright (C) 2019 - 2024 by [vroncevic.github.io/gen_rpc](https://vroncevic.github.io/gen_rpc)\n\n**gen_rpc** is free software; you can redistribute it and/or modify\nit under the same terms as Python itself, either Python version 3.x or,\nat your option, any later version of Python 3 you may have available.\n\nLets help and support PSF.\n\n[](https://www.python.org/psf/)\n\n[](https://psfmember.org/index.php?q=civicrm/contribute/transact&reset=1&id=2)\n",
"bugtrack_url": null,
"license": "GPL 2024 Free software to use and distributed it.",
"summary": "Generating RPC modules",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://vroncevic.github.io/gen_rpc"
},
"split_keywords": [
"unix",
" linux",
" development",
" rpc",
" modules"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c01b1cebbce3d9a9a0ae3b4803dfb88b7f5cdcd8c5d9eac068f5e7d4d1047b9",
"md5": "395e39e1540058c4d959858e4cec8389",
"sha256": "e8ade374f76582eb6aa29c6f54bbe0e64c5a4201bb8c366b463c3ea4e59fa603"
},
"downloads": -1,
"filename": "gen_rpc-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "395e39e1540058c4d959858e4cec8389",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 28746,
"upload_time": "2024-07-09T17:12:50",
"upload_time_iso_8601": "2024-07-09T17:12:50.763248Z",
"url": "https://files.pythonhosted.org/packages/0c/01/b1cebbce3d9a9a0ae3b4803dfb88b7f5cdcd8c5d9eac068f5e7d4d1047b9/gen_rpc-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "707af4fb3a4dd114bbed926e11e4e490a4b11a650e7ad95d8953073c750b58cd",
"md5": "d76dc1904df5b327a4a8f55767c0fb94",
"sha256": "b75169a332383fb19252aed761ca48b0ef4e0d2332fc4d6009d82381f91fe266"
},
"downloads": -1,
"filename": "gen_rpc-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d76dc1904df5b327a4a8f55767c0fb94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24936,
"upload_time": "2024-07-09T17:12:53",
"upload_time_iso_8601": "2024-07-09T17:12:53.172270Z",
"url": "https://files.pythonhosted.org/packages/70/7a/f4fb3a4dd114bbed926e11e4e490a4b11a650e7ad95d8953073c750b58cd/gen_rpc-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 17:12:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gen-rpc"
}
JSON