setuptools-autover 1.0.2

setup.py

1. Add setuptools_autover to setup_requires argument

2. Set use_autover argument

   The value can be mapping, (a dict, for example) containing configuration or any Python value that evaluates as True.

Use with default settings

import setuptools

setup(
    name='example-package',
    use_autover=True,
    setup_requires=['setuptools_autover'],
)

Use with custom settings

import setuptools

setup(
    name='example-package',
    use_autover={
      'root_version': '0.0',
      'parse_tag': lambda tag: tag.lstrip('v'),
      'create_version': lambda ver: '{}.post{}'.format(ver.latest_version, ver.distance),
    },
    setup_requires=['setuptools_autover'],
)

Note that if the setup function is called for source tree not having version info available, setuptools_autover.RevisionInfoNotFoundError is raised.

From Python Code

from setuptools_autover import get_version

# Using default settings
version = get_version()

# Using custom settings
version = get_version(root_version='0.0')

Functions

setuptools_autover.config_to_get_version_kwargs(config)

Return kwargs dictionary for setuptools_autover.get_version based on the given configuration.

setuptools_autover.get_version(root_version=’0’, parse_tag=lambda tag: tag, create_version=pep440.create_post_with_dev)

The arguments are the same as the configurations passed for use_autover argument from setup.py

Return generated version

setuptools_autover.pep440.create_post_with_dev

Create version that uses post and dev parts for version between releases.

The version is created using the following rules:

• distance == 0 and not dirty ⇒ {latest_version}

  Released version

• distance == 0 and dirty ⇒ {latest_version+dirty}

  Released version with modified source tree

• distance > 0 and not dirty ⇒ {latest_version}.post0.dev{distance}+{commit}

  Released version

• distance > 0 and dirty ⇒ {latest_version+dirty}.post0.dev{distance}+{commit}-dirty

  Released version with modified source tree

Classes

setuptools_autover.GitRevisionInfoReader

Read revision info from Git repository.

Constructor arguments:

path

Path to repository root. If None, current working directory is used.

Default value: None

Members:

__call__(self)

Return setuptools_autover.RevisionInfo generated from Git history of HEAD.

Exceptions

setuptools_autover.AutoverError

Base class for exceptions thrown by setuptools_autover

setuptools_autover.InvalidConfigError

The configuration dict is not valid.

setuptools_autover.RevisionInfoNotFoundError

Version could not be generated because revision info was not found

Types

setuptools_autover.RevisionInfo

Named tuple containing revision info:

• latest_tag: The most recent tag (None if there is no tags before the current revision)

• distance: Number of commits since the most recent tag (0 if current revision is tagged)

• commit: Commit identifier for current revision

• dirty: Is the source tree dirty (not exactly the same as the code in the current revision). If there is no commits, the lastest_tag and commit should be None and dirty should be set to True

setuptools_autover.VersionInfo

Named tuple containing version info:

• latest_version: The most recent version (None if there is no released version before the current revision)

• distance: Number of commits since the most recent tag (0 if current revision is tagged)

• commit: Commit identifier for current revision

• dirty: Is the source tree dirty (not exactly the same as the code in the current revision)

RevisionInfo is information returned by VCS readers and is turned into VersionInfo using the parse_tag function.