Skip to main content

A tool for tracking and incrementing project version numbering.

Project description

version-badge codacy-coverage codacy-badge

A commandline utility for incrementing your project version numbers.

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"]
  1. searches the configured file references for “version” strings

  2. validates all version strings across all configured files.

  3. 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

0.5.0 (2018-11-25)

  • added new dover config option for projects using pyproject.toml

  • started use of black for code formating

0.4.0 (2018-03-10)

  • Added –dev option as a pre-release state.

  • Added –release option that clears any pre-release versioning.

  • Added –format option that allows user to control the format from the standard 0.0.0-dev.1 format.

0.3.1 (2018-03-02)

  • documentation update to deal with invalid README formating.

0.3.0 (2018-03-02)

  • added pre-release options

  • added –no-list option

  • expanded documentation

  • 100% code coverage

0.2.1 (2018-02-22)

  • expanded tests

  • general code clean up

0.2.0 (2018-02-22)

  • improved alignment of output

  • added additional version matching check

0.1.0 (2018-02-18)

  • initial commit

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

dover-0.5.1.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

dover-0.5.1-py3-none-any.whl (13.9 kB view hashes)

Uploaded Python 3

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