smarie / python-getversion Goto Github PK

View Code? Open in Web Editor NEW

13.0 5.0 2.0 1.42 MB

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

Home Page: https://smarie.github.io/python-getversion/

License: BSD 3-Clause "New" or "Revised" License

Python 98.13% Shell 1.87%

module version source binary package library pep396 pep427 setuptools wheel

python-getversion's Introduction

getversion

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

This is the readme for developers. The documentation for users is available here: 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

Running the tests

This project uses pytest.

pytest -v getversion/tests/

You may need to install requirements for setup beforehand, using

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:

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

You may need to install requirements for setup beforehand, using

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:

mkdocs build -f docs/mkdocs.yml

You may need to install requirements for doc beforehand, using

pip install -r ci_tools/requirements-doc.txt

Generating the test reports

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

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:

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

python-getversion's People

Contributors

Stargazers

Watchers

Forkers

hmaarrfk alexdoesh

python-getversion's Issues

Incorrect version found when a version of the module is installed and another version is added to the path

This happens typically when we develop new versions of an existing and already installed package.

Improve explanation when no `.git` folder is found (currently it talks about C:\)

Provide a readable explanation when git command is not available

When 'git' command is not in path, setuptools_scm get_version does not provide a readabale explanation. We should therefore rather check it upfront

from setuptools_scm import has_command
has_command('git')

`version` is still not correctly available on this package

make universal wheel and remove tests folder from wheel

get_version_using_pkgresources does not work properly

import makefun
found_version, detailed_results = get_module_version(makefun)
print(detailed_results)

yields

Version '1.8.0' found for module 'makefun' by strategy 'get_unzipped_wheel_or_egg_version', after the following failed attempts:
 - Attempts for module 'makefun':
   - <get_module_version_attr>: module 'makefun' has no attribute '__version__'
   - <get_version_using_pkgresources>: Another distribution of the same package (with version '1.8.0') is installed, but is not the one that was imported
   - <get_builtin_module_version>: Module makefun is not a built-in module
   - <get_unzipped_wheel_or_egg_version>: SUCCESS: 1.8.0

While it should have found it sooner, in get_version_using_pkgresources. The error message is not right: I am using the installed package, not any fancy one.

Fix issue with prerelease git versions where the dash before the version number disappears

Consider some random python module that is in a git-versioned folder, tagged as 1.0.0-rc1 (release candidate. See semantic versioning: https://semver.org/spec/v2.0.0-rc.1.html)

The following code does not retrieve the right version string: the dash before the pre-release info is removed

from getversion import get_module_version

# import whatever local folder or file is available in this git folder
import my_module

# get the version and details. it will fallback to using the setuptools_scm one
ver, details = get_module_version(my_module)
print(details)  # SUCCESS on the setuptools_scm one (the last one)
print(ver)       # prints "1.0.0rc1" instead of "1.0.0-rc1"

This has for example as consequence that the resulting version string is not compliant with semver while the initial git tag was:

from semver import parse_version_info
parse_version_info("1.0.0-rc1")  # this is ok
parse_version_info("1.0.0rc1")  # this fails

raises ValueError: 1.0.0rc1 is not valid SemVer string