vcheck.vcheck

vcheck.vcheck(mod, hexsha=None, version=None)

Checks a given module against either a git sha1 signature or a version.

The vcheck function is designed to provide a quick and easy way to verify any Python module within a git repository.

Parameters:

hexsha : str

A git sha1 signature indicating a particular commit.

version : str

A string indicating a particular git tag.

Returns:

bool

Whether the module checks out or not

Raises:

vcheck.VersionError

If there has been an error identifying the module version.