`libvcs.cmd.git`¶

For git(1).

Compare to: fabtools.git, salt.modules.git, ansible.builtin.git

Managers and Commands¶

libvcs provides Managers and Commands for git subcommands:

Managers (git.branches, git.tags, etc.) let you traverse repository entities intuitively with ORM-like filtering via QueryList
Commands are contextual ways to run git commands against a specific target entity

Git instance
├── branches: GitBranchManager
│   ├── ls() -> QueryList[GitBranchCmd]
│   ├── get() -> GitBranchCmd
│   └── create()
├── tags: GitTagManager
├── remotes: GitRemoteManager
├── stashes: GitStashManager
├── worktrees: GitWorktreeManager
├── notes: GitNotesManager
├── submodules: GitSubmoduleManager
└── reflog: GitReflogManager

Quick Example¶

from libvcs.cmd.git import Git

git = Git(path='/path/to/repo')

# List all branches
branches = git.branches.ls()

# Filter to remote branches only
remote_branches = git.branches.ls(remotes=True)

# Get a specific branch and rename it
branch = git.branches.get(branch_name='old-name')
branch.rename('new-name')

# Create and manage tags
git.tags.create(name='v1.0.0', message='Release 1.0')
tag = git.tags.get(tag_name='v1.0.0')
tag.delete()

Subcommands

Run git commands directly against a local git repo.

class libvcs.cmd.git.Git[source]¶

Bases: object

Run commands directly on a git repository.

Lite, typed, pythonic wrapper for git(1).

Parameters:: path (str | PathLike[str]) – Operates as PATH in the corresponding git subcommand.

Examples

>>> git = Git(path=example_git_repo.path)
>>> git
<Git path=...>

Subcommands:

>>> git.remotes.show()
'origin'

>>> git.remotes.add(
...     name='my_remote', url=f'file:///dev/null'
... )
''

>>> git.remotes.show()
'my_remote\norigin'

>>> git.stash.save(message="Message")
'No local changes to save'

>>> git.submodule.init()
''

# Additional tests

>>> git.remotes.get(remote_name='my_remote').remove()
''
>>> git.remotes.show()
'origin'

>>> git.stash.ls()
''

>>> git.stashes.ls()
[]

>>> git.tags.create(name='v1.0.0', message='Version 1.0.0')
''

>>> any(t.tag_name == 'v1.0.0' for t in git.tags.ls())
True

__init__(*, path, progress_callback=None)[source]¶

Lite, typed, pythonic wrapper for git(1).

Parameters:

path (str | PathLike[str]) – Operates as PATH in the corresponding git subcommand.
progress_callback (ProgressCallbackProtocol | None)

Return type:

None

Examples

>>> git = Git(path=example_git_repo.path)
>>> git
<Git path=...>

Subcommands:

>>> git.remotes.show()
'origin'

>>> git.remotes.add(
...     name='my_remote', url=f'file:///dev/null'
... )
''

>>> git.remotes.show()
'my_remote\norigin'

>>> git.stash.save(message="Message")
'No local changes to save'

>>> git.submodule.init()
''

# Additional tests

>>> git.remotes.get(remote_name='my_remote').remove()
''
>>> git.remotes.show()
'origin'

>>> git.stash.ls()
''

>>> git.stashes.ls()
[]

>>> git.tags.create(name='v1.0.0', message='Version 1.0.0')
''

>>> any(t.tag_name == 'v1.0.0' for t in git.tags.ls())
True

path: Path¶: Directory to check out

progress_callback: ProgressCallbackProtocol | None = None¶

submodule: GitSubmoduleCmd¶

submodules: GitSubmoduleManager¶

remotes: GitRemoteManager¶

stash: GitStashCmd¶

stashes: GitStashManager¶

branches: GitBranchManager¶

tags: GitTagManager¶

worktrees: GitWorktreeManager¶

notes: GitNotesManager¶

reflog: GitReflogManager¶

run(args, *, version=None, _help=None, html_path=None, man_path=None, info_path=None, C=None, cwd=None, git_dir=None, work_tree=None, namespace=None, super_prefix=None, exec_path=None, bare=None, no_replace_objects=None, literal_pathspecs=None, global_pathspecs=None, noglob_pathspecs=None, icase_pathspecs=None, no_optional_locks=None, config=None, config_env=None, log_in_real_time=False, **kwargs)[source]¶

Run a command for this git repository.

Passing None to a subcommand option, the flag won’t be passed unless otherwise stated.

git help and git help [cmd]

Wraps git’s Options.