gitspy 0.1.1

Intuitive Git for Python

Intuitive Git for Python

Install

Dependencies: git ^2.0.0 (tested)

pip install gitspy

Development

poetry install

Example Usage

Get branch

>>> import gitspy
>>> git = gitspy.Git()
>>> # capture will store stdout, which can then be consumed by
>>> # calling `git.stdout()`
>>> # default is to print stdout, and stderr, to console
>>> returncode = git.symbolic_ref("--short", "HEAD", capture=True)
>>> print(returncode)  # printing returncode
0
>>> # consume stdout, a list containing a `str` of the checked out
>>> # branch
>>> stdout = git.stdout()  # -> ['checked-out-branch']
>>> items = len(stdout)  # printing length of `stdout()` outputs
>>> print(items)
1
>>> # no commands have been called yet since last call to `stdout`,
>>> # so stdout is empty
>>> stdout = git.stdout()  # -> []
>>> items = len(stdout)  # printing length of ``stdout()`` outputs
>>> print(items)
0
>>> # stdout can be accrued
>>> # ['checked-out-branch', 'checked-out-branch']
>>> git.symbolic_ref("--short", "HEAD", capture=True)
>>> git.symbolic_ref("--short", "HEAD", capture=True)
>>> print(len(git.stdout()))
2
>>> # stdout is consumed
>>> print(len(git.stdout()))
0
>>> git.symbolic_ref("--short", "HEAD", capture=True)
>>> git.stdout()  # [...] -> void; clear stdout, if it exists
>>> print(len(git.stdout()))
0

Get commit hash

>>> import gitspy
>>> git = gitspy.Git()
>>> git.rev_parse("HEAD", capture=True)
>>> stored = git.stdout()[0]
>>> print(len(stored))  # print the length of the unique hash
40