ingot-psql 0.1.0

Provides integration with the PostgresQL DB for Ingots projects

Ingot Psql Ingot package.

Provides integration with the PostgresQL DB for Ingots projects

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-psql-cli <command>

Getting package CLI help:

ingot-psql-cli --help
ingot-psql-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-postgresql.git
cd ingot-psql

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_psql.scripts.ingot_psql ...