Skip to main content

obsoleted by setuptools_scm

Project description

This module is a simple drop-in to support in mercurial and git based projects.

Alternatively it can be a setup time requirement.

It extracts the last Tag as well as the distance to it in commits from the scm, and uses these to calculate a version number

By default, it will increment the last component of the Version by one and append .dev{distance} in case the last component is .dev, the version will be unchanged

Tis requires always using all components in tags (i.e. 2.0.0 instead of 2.0) to avoid misstakenly releasing higher version (i.e. 2.1.devX instead of 2.0.1.devX)

It uses 4 strategies to archive its task:

  1. try to directly ask hg for the tag/distance

  2. try to infer it from the .hg_archival.txt file

  3. try to read the exact version the cache file if it exists

  4. try to read the exact version from the ‘PKG-INFO’ file as generated by sdists (this is a nasty abuse)

The most simple usage is:

from setuptools import setup
from hgdistver import get_version

get_version takes the optional argument cachefile, which causes it to store the version info in a python script instead of abusing PKG-INFO from a sdist.

The setup requirement usage is:

from setuptools import setup

The requirement uses the setup argument cache_hg_version_to instead of cachefile.

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

hgdistver-0.25.tar.gz (9.9 kB view hashes)

Uploaded source

Built Distribution

hgdistver-0.25-py2.py3-none-any.whl (7.4 kB view hashes)

Uploaded 2 7

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