Skip to main content

Tool to help manage the version of a Poetry project.

Project description

Tool to help manage the version of a Poetry project.

It updates the version of a Poetry project both in:

  • The pyproject.toml file: in the tool.poetry section.
  • All the __init__.py files of the packages registered in the tool.poetry.packages section of the pyproject.toml file.

The reason for having the version in both places is to be able to easily access the version at runtime by importing the package and reading the __version__ attribute in the __init__.py file, and still having the version in the pyproject.toml file for Poetry during the package build.

It is mainly made for being used in CI pipelines to automatically increment the versions at each deployment. But is also very helpful for manual usage, as it maintain consistancy between the versions in the pyproject.toml and the __init__.py files at all time.

Install

$ pip install poetry_incr_version # Easiest method for CI.

$ pipx install poetry_incr_version # Preferable in some cases, for exemple to install globally on your machine.

Usage

$ poetry-incr-version --minor . # Increment the minor version of the project in the current directory.

$ poetry-incr-version --set 1.2.3 path/to/project # Sets the version of the project inside path/to/project to '1.2.3'.

See .gitlab-ci.yml for a real use case.

Notes

  • No runtime dependencies: it is fast and easy to install.
  • Requires at least python 3.11: neeeded to parse the pyproject.toml.
  • Tested: checked by Pyright with strict mode, Ruff with all lint rules, Pytest with 100% test coverage and also by the CI pipelines of the project itself.

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

poetry_incr_version-0.1.9.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

poetry_incr_version-0.1.9-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file poetry_incr_version-0.1.9.tar.gz.

File metadata

  • Download URL: poetry_incr_version-0.1.9.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/5.15.154+

File hashes

Hashes for poetry_incr_version-0.1.9.tar.gz
Algorithm Hash digest
SHA256 57392a91f73755ec69c525c89544e94e0f301829e10aa62a8b6e464c36aab441
MD5 85bd83d01f7b1364bb7f16c89aa63fa5
BLAKE2b-256 16460be05b78850777f3d48f7b6ba706859d5e3c84e3bc64696ef17c8af2efbd

See more details on using hashes here.

File details

Details for the file poetry_incr_version-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for poetry_incr_version-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 f01bb3826666c19873133b6fd7f831baab68f1b61704a8f31114d5009b3a3891
MD5 73dee4d2040cddcefd6523626e96953c
BLAKE2b-256 347ddcae95844d1ec883a8bfb35111684a8c99a511a588d554a6e458a2dc0855

See more details on using hashes here.

Supported by

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