Welcome to jaraco.vcs documentation!

>>> repo().get_current_version()
'...'
>>> isinstance(repo(), Repo)
True
class jaraco.vcs.Git(location='.')

Bases: Subprocess, Git, Repo

A RepoManager implemented by calling into the ‘git’ command-line as a subprocess.

priority = 1
class jaraco.vcs.Mercurial(location='.')

Bases: Subprocess, Mercurial, Repo

A Repo implemented by calling into the ‘hg’ command-line as a subprocess.

priority = 1
class jaraco.vcs.Repo(location='.')

Bases: Versioned

An abstract class defining some interfaces for working with repositories.

static detect(location='.')
static existing_only(managers)

Return only those managers that refer to an existing repo

find_all_files()

Find files including those in subrepositories.

find_files()
find_root()
get_parent_revs(rev=None)

Get the parent revision for the specified revision (or the current revision if none is specified).

get_parent_tags(rev=None)
Return the tags for the parent revision (or None if no single

parent can be identified).

get_repo_tags()

Get all tags for the repository.

get_tags(rev=None)

Get the tags for the specified revision (or the current revision if none is specified).

classmethod get_valid_managers(location)

Get the valid RepoManagers for this location.

is_modified()

Does the current working copy have modifications

is_valid()

Return True if this is a valid manager for this location.

setup()
sub_paths()
subrepos()
jaraco.vcs.repo(location='.')
class jaraco.vcs.subprocess.Git(location='.')

Bases: Subprocess, Git, Repo

A RepoManager implemented by calling into the ‘git’ command-line as a subprocess.

priority = 1
class jaraco.vcs.subprocess.Mercurial(location='.')

Bases: Subprocess, Mercurial, Repo

A Repo implemented by calling into the ‘hg’ command-line as a subprocess.

priority = 1
class jaraco.vcs.subprocess.Subprocess

Bases: object

env = None
class jaraco.vcs.cmd.Command

Bases: object

is_valid()
version()

Return the underlying version

class jaraco.vcs.cmd.Git

Bases: Command

exe = 'git'
find_files()
find_root()
get_ancestral_tags(rev=None)

Like get_repo_tags, but only get those tags ancestral to the current changeset.

get_repo_tags()
get_tags(rev=None)

Return the tags for the current revision as a set

is_modified()

Is the current state modified? (currently stubbed assuming no)

is_valid()
sub_paths()
version_pattern = 'git version (\\d+\\.\\d+[^ ]*)'
version_suitable()
class jaraco.vcs.cmd.Mercurial

Bases: Command

exe = 'hg'
find_files()

Find versioned files in self.location

find_root()
get_ancestral_tags(rev='.')

Like get_repo_tags, but only get those tags ancestral to the current changeset.

get_parent_revs(rev=None)
get_repo_tags()
get_tags(rev=None)

Get the tags for the given revision specifier (or the current revision if not specified).

is_modified()
sub_paths()
version_pattern = 'Mercurial Distributed SCM \\((.*?)\\)'
class jaraco.vcs.cmd.TaggedRevision(tag, revision)

Bases: tuple

revision

Alias for field number 1

tag

Alias for field number 0

Indices and tables