Ingot Protobuf Ingot package.

Provides protobuf functionality for Ingots projects

For consumers

For using the Ingot package just execute the following command:

pip install ingot_protobuf

Of course, need to activate a destination virtual environment:

source .venv/bin/activate

... or to create it, if it hasn't prepared yet:

python3 -m venv .venv

Bootstrap

The Ingot package provides the Bootstrap CLI tool. It allows to get started with the Ingot package quickly. It generates the following skeletons: TODO. Add builders here after generating theirs by the ingots package_bootstrap tool.

For using the CLI tool just call the following command:

ingot-protobuf <command> --name=<entity_name> --description="The <entity> brief description."

Getting help:

ingot-protobuf --help
ingot-protobuf <command> --help

For developers

Prepare the project for working

Clone a repository:

mkdir ingots-libs
cd ingots-libs
git clone https://github.com/<path>/ingot_protobuf.git
cd ingot_protobuf

Prepare a virtual environment:

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

Prepare repository hooks

pip install pre_commit
pre-commit install

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. Set the {NAME}_VERSION_SUFFIX virtual variable for specify package suffix.

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 bootstrap locally

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

Use the following command instead:

python -m ingot_protobuf.scripts.ingot_protobuf ...