versionclimber.config.Package

class versionclimber.config.Package(name=None, vcs='pypi', url=None, cmd='pip install -U', build_cmd=None, version=None, conda=False, recipe=None, channels=None, hierarchy='commit', supply='minor', directory='.vclimb')

Package description

TODO: Document the different options.

• name : name of the package

• vcs: Versioning Control System

  • pypi : package versions are on pypi

  • conda : package versions are on a conda repository

  • git : retrieve versions from git

  • svn : retrieve versions from svn

  • path : the package source code is stored locally

• urllink to retrieve the source code of the package

  This is needed for git or svn repository

• cmd : how to install the package

• build_cmd : how to build the package before installing it

• version : the minimum version of the package. Traverse only higher versions.

• conda : either True, False or mamba if we want to install package with mamba.

__init__(name=None, vcs='pypi', url=None, cmd='pip install -U', build_cmd=None, version=None, conda=False, recipe=None, channels=None, hierarchy='commit', supply='minor', directory='.vclimb')

Methods

__init__([name, vcs, url, cmd, build_cmd, ...])
checkout_update(commit[, version])
clone()
get_version(commit[, version])
local_install(commit[, version, python])	Checkout or update the package to a given commit version.
restore()	Set the active commit version to HEAD or master.
versions([tags])