Btukfyl

I use pbr for packaging. It takes the version from git tags and applies that to setup.py

Now I also want to have the version available inside the package. For instance to have a __version__ attribute. Can I use the pbr library for this?

There is another library: versioneer that also extracts the version from the git tags, but that would add an extra requirement. I would prefer to get this functionality from pbr

Consider setuptools_scm, which pulls a version from a git or hg tag when available, or generates an appropriate dev release version (e.g., hgvs-1.2.5.dev6+hb5d989061852.d20181124). The version is written into package metadata as with a hardcoded version. No non-standard runtime support is needed.

Although I've used setuptools_scm for many projects, I've not used PBR. I was curious and worked up this simple demo:

snafu$ head setup.py setup.cfg pbrversiontest/*.py

==> setup.py <==

from setuptools import setup



setup(

    setup_requires=[

        "pbr",

        "setuptools_scm"

    ],

    pbr=True,

    use_scm_version=True,

)



==> setup.cfg <==

[metadata]

name = pbrversiontest

summary = test whether we can use pbr and setuptools_scm



[files]

packages =

    pbrversiontest



==> pbrversiontest/__init__.py <==

# This is straight from setuptools_scm README

from pkg_resources import get_distribution, DistributionNotFound

try:

    __version__ = get_distribution(__name__).version

except DistributionNotFound:

    # package is not installed

    pass



==> pbrversiontest/__main__.py <==

# this isn't required -- only for the demo

import pbrversiontest



print("version is " + pbrversiontest.__version__)

In the development directory, you might have a session like so:

snafu$ python3.6 -mvenv venv/3.6

snafu$ source venv/3.6/bin/activate

(3.6) snafu$ git tag 0.1.2

(3.6) snafu$ pip install -e .

(3.6) snafu$ python -m pbrversiontest 

version is 0.1.2

(3.6) snafu$ pip install wheel

(3.6) snafu$ python setup.py bdist_wheel

...

creating 'dist/pbrversiontest-0.1.2-py3-none-any.whl' and adding 'build/bdist.linux-x86_64/wheel' to it

...

(3.6) snafu$ unzip -l dist/pbrversiontest-0.1.2-py3-none-any.whl 

Archive:  dist/pbrversiontest-0.1.2-py3-none-any.whl

  Length      Date    Time    Name

---------  ---------- -----   ----

      192  2018-11-25 05:26   pbrversiontest/__init__.py

       73  2018-11-25 05:46   pbrversiontest/__main__.py

       33  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/AUTHORS

      217  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/METADATA

       92  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/WHEEL

       47  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/pbr.json

       15  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/top_level.txt

      675  2018-11-25 06:06   pbrversiontest-0.1.2.dist-info/RECORD

---------                     -------

     1344                     8 files

If you are fine with pbr being a runtime dependency of your package, then you can use the VersionInfo class from pbr.version:

from pbr.version import VersionInfo



package_name='my_package'

info = VersionInfo(package_name)



print(info.version_string())

(See also How to load package version into __version__ variable if you are using pbr?)