BUILD.md

How to build and test ydb-python-sdk

This document has detailed instructions on how to build ydb-python-sdk from source and run style and unit tests.

Pre-requisites

• Install Docker.
• Install Python
• Install pip
• Install Tox

Clone the repository

git clone https://github.com/ydb-platform/ydb-python-sdk

Run style tests

Use the command below to prepare virtualenv and to run style tests using flake8.

tox -e style

Run formatting checks

Use the command below to prepare virtualenv and to run style tests using black. See documentation about Black project.

tox -e black

To automatically format code using the black formatting style, use the command below.

tox -e black-format

Run unit tests

Use the command below to run unit tests.

tox -e py -- ydb

Run integration tests

Use the command below to run integration tests.

tox -e py -- tests

Regenerate protobuf

Use the command below for regenerate protobuf code.

make protobuf