getversion 0.5.0

Get the version number of any python module or package, reliably.

# python-getversion

(hopefully) universal library to get the package version number of a python module, by combining various strategies (PEP396/version, setuptools/pkg_resources, PEP427/wheel, git…)

[](https://pypi.python.org/pypi/getversion/) [](https://travis-ci.org/smarie/python-getversion) [](https://smarie.github.io/python-getversion/junit/report.html) [](https://codecov.io/gh/smarie/python-getversion)

[](https://smarie.github.io/python-getversion/) [](https://pypi.python.org/pypi/getversion/) [](https://pepy.tech/project/getversion) [](https://pepy.tech/project/getversion) [](https://github.com/smarie/python-getversion/stargazers)

This is the readme for developers. The documentation for users is available here: [https://smarie.github.io/python-getversion/](https://smarie.github.io/python-getversion/)

## Want to contribute ?

Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.

Here is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-getversion/issues](https://github.com/smarie/python-getversion/issues)

## Running the tests

This project uses pytest.

`bash pytest -v getversion/tests/ `

You may need to install requirements for setup beforehand, using

`bash pip install -r ci_tools/requirements-test.txt `

## Packaging

This project uses setuptools_scm to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases:

`bash python setup.py egg_info bdist_wheel rotate -m.whl -k3 `

You may need to install requirements for setup beforehand, using

`bash pip install -r ci_tools/requirements-setup.txt `

## Generating the documentation page

This project uses mkdocs to generate its documentation page. Therefore building a local copy of the doc page may be done using:

`bash mkdocs build -f docs/mkdocs.yml `

You may need to install requirements for doc beforehand, using

`bash pip install -r ci_tools/requirements-doc.txt `

## Generating the test reports

The following commands generate the html test report and the associated badge.

`bash pytest --junitxml=junit.xml -v getversion/tests/ ant -f ci_tools/generate-junit-html.xml python ci_tools/generate-junit-badge.py `

### PyPI Releasing memo

This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:

`bash twine upload dist/* -r pypitest twine upload dist/* `