Project description

versionfinder

Python package to find the version of another package/distribution, whether installed via pip, setuptools or git

Overview

versionfinder is a library intended to identify the version/source details of a
specified Python distribution (usually the one calling it), whether it was
installed via pip, setuptools or git. This is intended to allow packages to
determine what version they are, beyond what is simply coded in the package:

For packages installed via pip, return the exact requirement that was installed,
even if it was a source control URL (editable or not).

For packages installed via setuptools, return the installed version.

For packages that are a git clone, return the URL, commit, tag, and whether the
repository is dirty (modified) or not.

This is mainly intended for projects that need to display their version information
to users (i.e. for use in filing bug reports or support requests) and wish to be as
specific as possible, including whether the package was installed from a fork, a specific
tag or commit from a git repo, or has local changes not committed to git.

Requirements

Python 2.7, or Python 3.3+. Python 3.0-3.2 is not supported. Python 2.6 should
function, but will not return detailed git information and is not tested.

Usage

Versionfinder is primarily intended to return information about the package/
distribution it is called from. As some operations can be quite a bit more time
consuming than simply reading a pkg_resources or pip distribution version,
it’s recommended that Versionfinder be run once during the startup or initialization
of your application/process, and the result stored for later use.

The simplest example is finding the version information for whatever package/distribution
contains the calling module. In mymodule.py, a module within the “mypackage”
package/distribution:

importloggingfromversionfinderimportfind_version# If you are using the python logging module, you'll likely want to# suppress logging from versionfinder itself, as well as the DEBUG-level# logging from ``pip`` and ``git``, which are called by versionfinder.forlnamein['versionfinder','pip','git']:l=logging.getLogger(lname)l.setLevel(logging.CRITICAL)l.propagate=TrueclassMyClass(object):def__init__(self):self._versioninfo=find_version('mypackage')@propertydefversioninfo(self):returnself._versioninfo

The _versioninfo attribute of the class will be set to the VersionInfo
object returned by find_version(). We can inspect some of that object’s
properties, which are documented in the
API docs.

Bugs and Feature Requests

Bug reports and feature requests are happily accepted via the GitHub Issue Tracker. Pull requests are
welcome. Issues that don’t have an accompanying pull request will be worked on
as my time and priority allows.

Guidelines

Testing

If you want to pass additional arguments to pytest, add them to the tox command line after “–”. i.e., for verbose pytext output on py27 tests: tox -e py27 ---v

Acceptance Tests

Versionfinder has a suite of acceptance tests that create virtualenvs, install a
test package (versionfinder-test-pkg) in them,
and then call versionfinder.find_version() from multiple locations in the package, printing a JSON-serialized
dict of the results of each call (and an exception, if one was caught). For further information
on the acceptance tests, see versionfinder/tests/test_acceptance.py.

Currently-tested scenarios are:

Pip

Install from local git clone

Install editable from local git clone

Install editable from local git clone then change a file (dirty)

Install editable from local git clone then commit and tag

Install editable from local git clone checked out to a tag

Install editable from local git clone checked out to a commit

Install editable from local git clone with multiple remotes

Install from sdist

Install from sdist with pip 1.5.4

Install from wheel

Install from git URL

Install from git fork URL

Install from git URL with commit

Install from git URL with tag

Install from git URL with branch

Install editable from git URL

Install editable from git fork URL

Install editable from git URL with multiple remotes

Install editable from git URL and then change a file in the clone (dirty)

Install editable from git URL with commit

Install editable from git URL with tag

Install editable from git URL with branch

Install sdist in a venv that’s also a git repo

Install wheel in a venv that’s also a git repo

setuptools / setup.py

setup.py develop

setup.py install

easy_install

Install from sdist

Install from egg

Install from source directory

Install from sdist in a venv that’s also a git repo

Install from egg in a venv that’s also a git repo

Install from source directory in a venv that’s also a git repo

Release Checklist

Open an issue for the release; cut a branch off master for that issue.

Confirm that there are CHANGES.rst entries for all major changes.

Ensure that Travis tests passing in all environments.

Ensure that test coverage is no less than the last release (ideally, 100%).

Increment the version number in versionfinder/version.py and add version and release date to CHANGES.rst, then push to GitHub.