git_wrapper

Python wrapper around GitPython

• Free software: MIT license
• Documentation: https://git-wrapper.readthedocs.io.

Notes

This library only supports python 3. Some features may still work with python 2.7 but not all of the syntax and features may be compatible.

Development

git_wrapper supports both standard python virtual environment setups and pipenv, which is integrated into our Makefile. To set up a pipenv-based development enironment, you can simply run:

make dev

This will install our dev environment for the package via pipenv. It is installed with --user, so it does not affect your site-packages. Pipenv creates a unique virtualenv for us, which you can activate via:

pipenv shell

See the pipenv documentation for more detail.

Documentation

To build the documentation on your checkout, simply run:

make docs

Contributions

All new code should include tests that exercise the code and prove that it works, or fixes the bug you are trying to fix. Any Pull Request without tests will not be accepted. See CONTRIBUTING.rst for more details.

Building

If you wish to build a local package for testing at any time, you can simply run:

make dist

this will build a package with a .dev extension that you can install for testing and verification.

Pushing a new release

1. Prepare a patch to update the version number (example). Note that we no longer need to update __version__ manually, just the HISTORY.rst file.
2. Once that's merged, tag that patch and push the new tag to the repo
3. Github Actions will then automatically build and publish a new release.