Skip to main content

Provides gRPC functionality based on the grpclib package

Project description

Ingot Grpclib Ingot package.

Provides gRPC functionality based on the grpclib package

For consumers

For using the Ingot package just execute the following commands:

  • Add the package to the requirements.txt file of your project.
  • Install int using the pip tool.
  • TODO. Add here something extra information.

Package CLI

The package provides CLI. It allows to start working with the package quickly. It contains the following commands: TODO. Add builders here after generating their by the ingots package_bootstrap tool.

For using the CLI tool just call the following command:

ingot-grpclib-cli <command>

Getting package CLI help:

ingot-grpclib-cli --help
ingot-grpclib-cli <command> --help

For developers

Prepare the project for working

Clone a repository:

mkdir ingots-libs
cd ingots-libs
git clone https://github.com/ABKorotky/ingot-grpclib
cd ingot-grpclib

Prepare a virtual environment:

python3.9 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Prepare repository hooks

pip install pre_commit
pre-commit install
pre-commit autoupdate

Configure code-quality tools:

pip install black flake8 mypy coverage

Configure the Sphinx tool

Please, use the following page for configuring the Sphinx documentation generator: Sphinx

pip install sphinx
sphinx-build -b html docs docs/build -v

Using the tox tool

The Ingot package allows automation via the tox tool.

pip install tox

Use configured tox tool for several activities.

tox -e reformat - auto reformat code by the black tool, makes ordering import too.

tox -e cs - checks code style by PEP8.

tox -e ann - checks annotations of types by the mypy tool.

tox -e utc - runs unittests with the coverage tool.

tox -e report - builds coverage report for the project.

tox -e doc - builds a package documentation.

tox -e build - builds a package form current branch / tag / commit.

tox -e upload - uploads package to the PyPI index. Set the PYPI_REPOSITORY_ALIAS virtual variable for specify PyPI destination.

Calling tox without parameters will execute the following steps: cs, ann, utc and report.

Using package CLI locally

Obviously, it's impossible to call the package CLI via package entry-point.

Use the following command instead:

python -m ingot_grpclib.scripts.ingot_grpclib ...

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

ingot-grpclib-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

ingot_grpclib-0.1.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file ingot-grpclib-0.1.0.tar.gz.

File metadata

  • Download URL: ingot-grpclib-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.2

File hashes

Hashes for ingot-grpclib-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bc5a39adf4402989f6259c72a49ff1785071cb05db37e3f165762d56318094dd
MD5 2a8e8a6e4da1e8fef3e13975f6bd4917
BLAKE2b-256 492ef3d4e619ddd2157b908e5db00462dcd032cb6c45cc29d4253753e3714f99

See more details on using hashes here.

File details

Details for the file ingot_grpclib-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ingot_grpclib-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.2

File hashes

Hashes for ingot_grpclib-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 296fbb4818029fab3097c80f107a088a796b1523af194e386e67250057fccfe7
MD5 c83183e2f604de6f292fb9197b462029
BLAKE2b-256 9f995942c3defaf8e530ba3a72222e31dee2f4505e4e3de3971d0ca12b45b3c4

See more details on using hashes here.

Supported by

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