Skip to main content

obsoleted by setuptools_scm

Project description

This module is a simple drop-in to support setup.py 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 setup.py sdists (this is a nasty abuse)

The most simple usage is:

from setuptools import setup
from hgdistver import get_version
setup(
    ...,
    version=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
setup(
    ...,
    get_version_from_hg=True,
    setup_requires=['hgdistver'],
    ...,
)

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file hgdistver-0.25.tar.gz.

File metadata

  • Download URL: hgdistver-0.25.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hgdistver-0.25.tar.gz
Algorithm Hash digest
SHA256 603bed5bcd892252b4501375fbca4a24de7937418e0a6ef299e3902c5a198d8d
MD5 3ac7984dbfc2bdbb85da4a656aee15dd
BLAKE2b-256 987b337f0108b7d2236a6c76eadfd457815fb91b0aa637e43c22947fa7f4050c

See more details on using hashes here.

File details

Details for the file hgdistver-0.25-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for hgdistver-0.25-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a50a63ee89ac25a8a5a6a4a8fed85b3dd7c0bde1acacf6e21e1803190a3a3648
MD5 c14f1f60816a90b59824d419b2644f87
BLAKE2b-256 67b4e7dd4b17a0a1600e1c441f597b1886d069ce52126cc1d7c907a4b8e889fd

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