Embed git hash into python file when installing

Question

I want to embed the git hash into the version number of a python module if that module is installed from the git repository using ./setup.py install. How do I do that?

My thought was to define a function in setup.py to insert the hash and arrange to have it called when setup has copied the module to its build/lib/ directory, but before it has installed it to its final destination. Is there any way to hook into the build process at that point?

Edit: I know how to get the hash of the current version from the command line, I am asking about how to get such a command to run at the right time during the build/install.

possible duplicate of How can I rewrite python __version__ with git? — Sam Nicholls
– Sam Nicholls, Commented Jul 23, 2013 at 13:55
Off the cuff: git log -n 1 | grep commit would be a useful command to execute in the root of your project. — yurisich
– yurisich, Commented Jul 23, 2013 at 14:05
@SamStudio8: Not a duplicate, that question asks about how to get the hash at commit time. I want to do it when I build a package, so I'm asking about a hook in the setup.py machinery. — JanKanis
– JanKanis, Commented Jul 23, 2013 at 19:02
@Droogans I know that part, now how do I get to run it at the right time? — JanKanis
– JanKanis, Commented Jul 23, 2013 at 19:03
@Somejan The second answer in the question links to a relevant looking setup.py? — Sam Nicholls
– Sam Nicholls, Commented Jul 24, 2013 at 9:52

0 _ · Accepted Answer · 2021-09-18 12:54:38Z

Another, possibly simpler way to do it, using gitpython, as in dd/setup.py:

from pkg_resources import parse_version  # part of `setuptools`


def git_version(version):
    """Return version with local version identifier."""
    import git
    repo = git.Repo('.git')
    repo.git.status()
    # assert versions are increasing
    latest_tag = repo.git.describe(
        match='v[0-9]*', tags=True, abbrev=0)
    assert parse_version(latest_tag) <= parse_version(version), (
        latest_tag, version)
    sha = repo.head.commit.hexsha
    if repo.is_dirty():
        return f'{version}.dev0+{sha}.dirty'
    # commit is clean
    # is it release of `version` ?
    try:
        tag = repo.git.describe(
            match='v[0-9]*', exact_match=True,
            tags=True, dirty=True)
    except git.GitCommandError:
        return f'{version}.dev0+{sha}'
    assert tag == f'v{version}', (tag, version)
    return version

cf also the discussion at https://github.com/tulip-control/tulip-control/pull/145

Collectives™ on Stack Overflow

Embed git hash into python file when installing

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related