Prozorro CDB Api (openprocurement.api)

Installation

docker-compose build
docker-compose up

Pre-commit

To install pre-commit simply run inside the shell:

uv run pre-commit install
uv run pre-commit install --hook-type commit-msg

pre-commit is very useful to check your code before publishing it. It's configured using .pre-commit-config.yaml file.

You can read more about pre-commit here: https://pre-commit.com/

Run tests

1. Build docker container

   docker compose build
   

2. Run tests

   docker compose run --rm api pytest src/openprocurement/tender/core -x -vvv
   

Docs

1. Update *.http files

   docker compose run --rm api pytest docs/tests -x -vvv
   

2. Generate docs

   docker compose run --rm api sh -c "cd docs && make html"
   

   See docs/build/html for the built doc files

3. See more

Manage dependencies

Sync your local virtual env with project requirements

Sync explicitly

uv sync --frozen

Or run any command with --frozen option and .venv will be synced automatically.

uv run --frozen pylint .

Manage requirement version

To add a requirement

uv add httpx

or with a constraint

uv add "aiohttp>=3.12,<4"

or

uv add aiohttp~=3.12

To add dev requirements

uv add pytest-aiohttp~=1.0  --group=dev

To add/update requirement with a github source

uv add git+https://github.com/ProzorroUKR/standards.git --rev 1.0.210

or by hash itself (tag version also adds hash to the lock file, so I prefer the option above)

uv add git+https://github.com/ProzorroUKR/standards.git --rev 06f4339cf69bddab93a830b387704be5c5ec9d7b

Manage lock versions

To update all package versions

uv lock --upgrade

To update only one package

uv lock --upgrade-package pymongo==4.14.1

Resolved 133 packages in 451ms
Updated pymongo v4.13.1 -> v4.14.1

Release tag creation

1. Update version in pyproject.toml using semver:

For release candidates use X.Y.Z-rc.N For final versions use X.Y.Z

2. Run uv sync, commit, push
3. Create tag:

The repository includes a helper command for creating annotated release tags with an autogenerated changelog message.

Supported command formats:

make tag VERSION=X.Y.Z
make tag VERSION=X.Y.Z PREV=A.B.C
make tag X.Y.Z
make tag X.Y.Z A.B.C

Notes:

• PREV (or positional A.B.C) is optional.
• If previous tag is not provided, tag command tries to detect it automatically.
• The script opens your editor before creating the tag so you can adjust the tag message.

For RC tags, use the previous RC tag if it exists:

make tag X.Y.Z-rc.N X.Y.Z-rc.[N-1]

Example:

make tag 1.2.3-rc.2 1.2.3-rc.1

For final tags, use the previous final tag:

make tag X.Y.Z A.B.C

Example:

make tag 1.2.3 1.2.4

4. Push tag:

git push origin X.Y.Z

More Documentation

Documentation

Development

Documentation maintenance