Skip to main content

Generating RPC modules

Project description

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.

gen_rpc python checker gen_rpc package checker GitHub issues open GitHub contributors

Table of Contents

Installation

Used next development environment

debian linux os

gen_rpc python3 build

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

Generation flow of RPC modules

Base flow of generation process

RPC generation flow

RPC System

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

RPC portmap

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

Documentation Status

More documentation and info at

Contributing

Contributing to gen_rpc

Copyright and Licence

License: GPL v3 License

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.

Python Software Foundation

Donate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gen_rpc-1.0.3.tar.gz (24.9 kB view details)

Uploaded Source

Built Distribution

gen_rpc-1.0.3-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file gen_rpc-1.0.3.tar.gz.

File metadata

  • Download URL: gen_rpc-1.0.3.tar.gz
  • Upload date:
  • Size: 24.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for gen_rpc-1.0.3.tar.gz
Algorithm Hash digest
SHA256 b75169a332383fb19252aed761ca48b0ef4e0d2332fc4d6009d82381f91fe266
MD5 d76dc1904df5b327a4a8f55767c0fb94
BLAKE2b-256 707af4fb3a4dd114bbed926e11e4e490a4b11a650e7ad95d8953073c750b58cd

See more details on using hashes here.

File details

Details for the file gen_rpc-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: gen_rpc-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for gen_rpc-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e8ade374f76582eb6aa29c6f54bbe0e64c5a4201bb8c366b463c3ea4e59fa603
MD5 395e39e1540058c4d959858e4cec8389
BLAKE2b-256 0c01b1cebbce3d9a9a0ae3b4803dfb88b7f5cdcd8c5d9eac068f5e7d4d1047b9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page