git_wrapper
Python wrapper around GitPython
Free software: MIT license
Documentation: https://git-wrapper.readthedocs.io.
Features
TODO
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
There are several dependencies needed to build and work on git_wrapper. Using your distribution’s package manager, install these system packages:
GitPython
git_wrapper uses the upcoming standard of Pipfiles via pipenv. This is integrated into our Makefile and once you have the above dependencies, 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
We plan to get this published in the near future, and this README will be updated when that happens.
Contributions
All new code should include tests that excercise 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.
Pushing a new release
Prepare a patch to update the version number (example)
You may want to check the HISTORY.rst file renders correctly before committing, as the twine upload will fail later if it doesn’t. Install one of these:
# dnf install python3-readme-renderer $ pip install readme-renderer
Then run the following command:
$ python -m readme_renderer README.rst -o /tmp/README.html
Once that’s merged, tag that patch and push the new tag to the repo
Run the following commands:
$ rm dist/* $ python setup.py sdist bdist_wheel $ twine upload --verbose dist/*
(You need to have a PyPI account with the right permissions for that last step.)
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.0.1 (2018-06-25)
First release on PyPI.
0.1.0 (2018-07-05)
Second release on PyPI.
Base functionality
git cherry support
Removing pipenv support.
0.2.0 (2019-01-18)
Third release on PyPI.
Major refactor to better align the data model.
- Added several new features
Log diff generation
Improved clone support including bare repos and destroy/reclone
Revert support
Support for rebasing to a branch or commit.
0.2.1 (2019-04-15)
Fourth release on PyPI.
- Added several new features
Add function to compare commit references
Add tagging functions
0.2.2 (2020-07-20)
Fifth release on PyPI.
Added new function to check if a commit exists on a given remote branch
0.2.3 (2020-12-15)
Added checkout parameter to branch creation and hard reset functions
0.2.4 (2021-01-11)
Added new function to cherry-pick a given commit
New parameter added to apply_patch() to preserve square brackets in commit messages
Added new function to grep logs
Deprecated location of other log functions in GitBranch, they should now be called from GitLog
0.2.5 (2021-01-12)
Fix RST formatting issue to unbreak Pypi uploads
0.2.6 (2021-02-11)
Add new log function to get a single commit’s information
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file git_wrapper-0.2.6.tar.gz.
File metadata
- Download URL: git_wrapper-0.2.6.tar.gz
- Upload date:
- Size: 38.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae4efaca9dfb768922a17fde05b8c1d690ce0ce6d0e8b6442d88e6c7cf439f75
|
|
| MD5 |
18e139725847e47b2fb5bc18b98a5756
|
|
| BLAKE2b-256 |
d98d4ba5fd99a7d16a77fe373e3a17ad375880294e6c4cda881c78da314f8106
|
File details
Details for the file git_wrapper-0.2.6-py3-none-any.whl.
File metadata
- Download URL: git_wrapper-0.2.6-py3-none-any.whl
- Upload date:
- Size: 17.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
df73319c0acfb5ff0613e84e26a20726a3fe3cd4a742f9f92df35d7a6b43a547
|
|
| MD5 |
5c400f8e627aa7047eddcb005104d2d3
|
|
| BLAKE2b-256 |
16e41d3db6ff978d03ee667560f0e4156d607f5f550018ca04dc028ae007df56
|
