Skip to main content

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.

Release files for hgdistver 0.25

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hgdistver 0.25
File Size Uploaded
hgdistver-0.25.tar.gz 9.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hgdistver 0.25
File Interpreter ABI Platform
hgdistver-0.25-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 17.3 kB

Release files / hgdistver-0.25.tar.gz

Download URL hgdistver-0.25.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
603bed5bcd892252b4501375fbca4a24de7937418e0a6ef299e3902c5a198d8d
BLAKE2b-256 checksum
How to use checksums
987b337f0108b7d2236a6c76eadfd457815fb91b0aa637e43c22947fa7f4050c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / hgdistver-0.25-py2.py3-none-any.whl

Download URL hgdistver-0.25-py2.py3-none-any.whl
Size 7.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a50a63ee89ac25a8a5a6a4a8fed85b3dd7c0bde1acacf6e21e1803190a3a3648
BLAKE2b-256 checksum
How to use checksums
67b4e7dd4b17a0a1600e1c441f597b1886d069ce52126cc1d7c907a4b8e889fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.25 This release

2 release files

0.24

2 release files

0.23

2 release files

0.22

2 release files

0.21

2 release files

0.20

2 release files

0.19

2 release files

0.18

2 release files

0.17

1 release file

0.16

1 release file

0.15

1 release file

0.14

1 release file

0.13

1 release file

0.12

1 release file

0.11

1 release file

0.10

1 release file

0.9

1 release file

0.8

1 release file

0.7

1 release file

0.6

1 release file

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page