README.md

Generate RPC modules

gen_rpc is tool for generation of RPC modules.

Developed in python 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.

Table of Contents

• Installation
  • Install using pip
  • Install using setuptools
  • Install using docker
• Dependencies
• Generation flow of RPC modules
• RPC System
• RPC Mapper
• Tool structure
• Docs
• Copyright and Licence

Installation

Used next development environment

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.

You can install by using pip

#python3
pip3 install gen_rpc

Install using build

Navigate to release page download and extract release archive.

To install gen-rpc run

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 download and extract release archive.

To install gen_rpc type the following

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

Generation flow of RPC modules

Base flow of generation process

RPC System

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

    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

More documentation and info at

• gen_rpc.readthedocs.io
• rpc mechanism
• www.python.org

Contributing

Contributing to gen_rpc

Copyright and Licence

Copyright (C) 2019 - 2024 by 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.