Installation

... pip install dover

What does it do?

When dover is run from the root directory of your project, it does the following:

1. looks for a configuration file (.dover, .dover.ini, setup.cfg, pyproject.toml)

2. reads any dover configuration line in this format:

   [dover:file:relatvie/file.pth]

Or in the case of pyproject.toml:

[tool.dover]
versioned_files = ["pyproject.toml", "dover/cli.py"]

3. searches the configured file references for “version” strings

4. validates all version strings across all configured files.

5. displays and/or increments the version strings based upon cli options.

Usage

... dover --help

dover v0.5.1

dover is a commandline utility for
tracking and incrementing your
project version numbers.

Usage:
  dover [--list] [--debug] [--format=<fmt>]
  dover increment ((--major|--minor|--patch)
                   [--dev|--alpha|--beta|--rc] |
                   [--major|--minor|--patch]
                   (--dev|--alpha|--beta|--rc) | --release)
                   [--apply] [--debug] [--no-list] [--format=<fmt>]

Options:
  -M --major      Update major version segment.
  -m --minor      Update minor version segment.
  -p --patch      Update patch version segment.
  -d --dev        Update dev version segment.
  -a --alpha      Update alpha pre-release segment.
  -b --beta       Update beta pre-release segment.
  -r --rc         Update release candidate segment.
  -R --release    Clear pre-release version.
  -x --no-list    Do not list files.
  --format=<fmt>  Apply format string.
  --debug         Print full exception info.
  -h --help       Display this help message
  --version       Display dover version.

See Read The Docs for more.

History