Skip to content

Commit db9032d

Browse files
author
Andrew Vitko
committed
The Original Master
1 parent a8031d5 commit db9032d

File tree

160 files changed

+3752
-4243
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+3752
-4243
lines changed

‎AUTHORS

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,19 @@ Contributors are:
2929
-Tim Swast <swast _at_ google.com>
3030
-William Luc Ritchie
3131
-David Host <hostdm _at_ outlook.com>
32-
32+
-A. Jesse Jiryu Davis <jesse _at_ emptysquare.net>
33+
-Steven Whitman <ninloot _at_ gmail.com>
34+
-Stefan Stancu <stefan.stancu _at_ gmail.com>
35+
-César Izurieta <cesar _at_ caih.org>
36+
-Arthur Milchior <arthur _at_ milchior.fr>
37+
-Anil Khatri <anil.soccer.khatri _at_ gmail.com>
38+
-JJ Graham <thetwoj _at_ gmail.com>
39+
-Ben Thayer <ben _at_ benthayer.com>
40+
-Dries Kennes <admin _at_ dries007.net>
41+
-Pratik Anurag <panurag247365 _at_ gmail.com>
42+
-Harmon <harmon.public _at_ gmail.com>
43+
-Liam Beguin <liambeguin _at_ gmail.com>
44+
-Ram Rachum <ram _at_ rachum.com>
45+
-Alba Mendez <me _at_ alba.sh>
46+
-Robert Westman <robert _at_ byteflux.io>
3347
Portions derived from other open source works and are clearly marked.

‎CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
### How to contribute
22

3-
* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub
4-
* For setting up the environment to run the self tests, look at `.travis.yml`.
5-
* Add yourself to AUTHORS.md and write your patch. **Write a test that fails unless your patch is present.**
6-
* Initiate a pull request
3+
The following is a short step-by-step rundown of what one typically would do to contribute.
4+
5+
* [fork this project](https://github.com/gitpython-developers/GitPython/fork) on GitHub.
6+
* For setting up the environment to run the self tests, please look at `.travis.yml`.
7+
* Please try to **write a test that fails unless the contribution is present.**
8+
* Try to avoid massive commits and prefer to take small steps, with one commit for each.
9+
* Feel free to add yourself to AUTHORS file.
10+
* Create a pull request.
711

‎Dockerfile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
#
77

88
FROM ubuntu:xenial
9-
MAINTAINER James E. King III <jking@apache.org>
9+
10+
# Metadata
11+
LABEL maintainer="jking@apache.org"
12+
LABEL description="CI environment for testing GitPython"
13+
1014
ENV CONTAINER_USER=user
1115
ENV DEBIAN_FRONTEND noninteractive
1216

‎MANIFEST.in

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
include VERSION
2-
include LICENSE
3-
include CHANGES
41
include AUTHORS
2+
include CHANGES
53
include CONTRIBUTING.md
4+
include LICENSE
65
include README.md
6+
include VERSION
77
include requirements.txt
88
include test-requirements.txt
99

1010
recursive-include doc *
11-
12-
graft git/test/fixtures
13-
graft git/test/performance
11+
recursive-exclude test *
1412

1513
global-exclude __pycache__ *.pyc

‎Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ release: clean
1515
make force_release
1616

1717
force_release: clean
18-
git push --tags origin master
18+
git push --tags origin main
1919
python3 setup.py sdist bdist_wheel
20-
twine upload -s -i byronimo@gmail.com dist/*
20+
twine upload -s -i 27C50E7F590947D7273A741E85194C08421980C9 dist/*
2121

2222
docker-build:
2323
docker build --quiet -t gitpython:xenial -f Dockerfile .
2424

2525
test: docker-build
2626
# NOTE!!!
27-
# NOTE!!! If you are not running from master or have local changes then tests will fail
27+
# NOTE!!! If you are not running from main or have local changes then tests will fail
2828
# NOTE!!!
2929
docker run --rm -v ${CURDIR}:/src -w /src -t gitpython:xenial tox
3030

‎README.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
## [Gitoxide](https://github.com/Byron/gitoxide): A peek into the future…
2+
3+
I started working on GitPython in 2009, back in the days when Python was 'my thing' and I had great plans with it.
4+
Of course, back in the days, I didn't really know what I was doing and this shows in many places. Somewhat similar to
5+
Python this happens to be 'good enough', but at the same time is deeply flawed and broken beyond repair.
6+
7+
By now, GitPython is widely used and I am sure there is a good reason for that, it's something to be proud of and happy about.
8+
The community is maintaining the software and is keeping it relevant for which I am absolutely grateful. For the time to come I am happy to continue maintaining GitPython, remaining hopeful that one day it won't be needed anymore.
9+
10+
More than 15 years after my first meeting with 'git' I am still in excited about it, and am happy to finally have the tools and
11+
probably the skills to scratch that itch of mine: implement `git` in a way that makes tool creation a piece of cake for most.
12+
13+
If you like the idea and want to learn more, please head over to [gitoxide](https://github.com/Byron/gitoxide), an
14+
implementation of 'git' in [Rust](https://www.rust-lang.org).
15+
116
## GitPython
217

318
GitPython is a python library used to interact with git repositories, high-level like git-porcelain,
@@ -19,7 +34,7 @@ If it is not in your `PATH`, you can help GitPython find it by setting
1934
the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
2035

2136
* Git (1.7.x or newer)
22-
* Python 2.7 to 3.7.
37+
* Python >= 3.6
2338

2439
The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`.
2540
The installer takes care of installing them for you.
@@ -64,9 +79,7 @@ separate process which can be dropped periodically.
6479

6580
#### Windows support
6681

67-
For *Windows*, we do regularly test it on [Appveyor CI](https://www.appveyor.com/)
68-
but not all test-cases pass - you may help improve them by exploring
69-
[Issue #525](https://github.com/gitpython-developers/GitPython/issues/525).
82+
See [Issue #525](https://github.com/gitpython-developers/GitPython/issues/525).
7083

7184
### RUNNING TESTS
7285

@@ -89,7 +102,7 @@ Then run:
89102
tox
90103

91104

92-
For more fine-grained control, you can use `nose`.
105+
For more fine-grained control, you can use `unittest`.
93106

94107
### Contributions
95108

@@ -110,12 +123,13 @@ Please have a look at the [contributions file][contributing].
110123

111124
### How to make a new release
112125

113-
* Update/verify the version in the `VERSION` file
114-
* Update/verify that the changelog has been updated
126+
* Update/verify the **version** in the `VERSION` file
127+
* Update/verify that the `doc/source/changes.rst` changelog file was updated
115128
* Commit everything
116129
* Run `git tag -s <version>` to tag the version in Git
117130
* Run `make release`
118-
* Finally, set the upcoming version in the `VERSION` file, usually be
131+
* Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_.
132+
* set the upcoming version in the `VERSION` file, usually be
119133
incrementing the patch level, and possibly by appending `-dev`. Probably you
120134
want to `git push` once more.
121135

@@ -128,18 +142,18 @@ This script shows how to verify the tarball was indeed created by the authors of
128142
this project:
129143

130144
```
131-
curl https://pypi.python.org/packages/5b/38/0433c06feebbfbb51d644129dbe334031c33d55af0524326266f847ae907/GitPython-2.1.8-py2.py3-none-any.whl#md5=6b73ae86ee2dbab6da8652b2d875013a > gitpython.whl
132-
curl https://pypi.python.org/packages/5b/38/0433c06feebbfbb51d644129dbe334031c33d55af0524326266f847ae907/GitPython-2.1.8-py2.py3-none-any.whl.asc > gitpython-signature.asc
145+
curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl > gitpython.whl
146+
curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl.asc > gitpython-signature.asc
133147
gpg --verify gitpython-signature.asc gitpython.whl
134148
```
135149

136150
which outputs
137151

138152
```
139-
gpg: Signature made Mon Dec 11 17:34:17 2017 CET
140-
gpg: using RSA key C3BC52BD76E2C23BAC6EC06A665F99FA9D99966C
141-
gpg: issuer "byronimo@gmail.com"
142-
gpg: Good signature from "Sebastian Thiel (I do trust in Rust!) <byronimo@gmail.com>" [ultimate]
153+
gpg: Signature made Fr 4 Sep 10:04:50 2020 CST
154+
gpg: using RSA key 27C50E7F590947D7273A741E85194C08421980C9
155+
gpg: Good signature from "Sebastian Thiel (YubiKey USB-C) <byronimo@gmail.com>" [ultimate]
156+
gpg: aka "Sebastian Thiel (In Rust I trust) <sebastian.thiel@icloud.com>" [ultimate]
143157
```
144158

145159
You can verify that the keyid indeed matches the release-signature key provided in this
@@ -159,7 +173,7 @@ If you would like to trust it permanently, you can import and sign it:
159173

160174
```
161175
gpg --import ./release-verification-key.asc
162-
gpg --edit-key 88710E60
176+
gpg --edit-key 4C08421980C9
163177
164178
> sign
165179
> save
@@ -179,25 +193,24 @@ gpg --edit-key 88710E60
179193
* [Loki](https://github.com/Neo23x0/Loki)
180194
* [Omniwallet](https://github.com/OmniLayer/omniwallet)
181195
* [GitViper](https://github.com/BeayemX/GitViper)
196+
* [Git Gud](https://github.com/bthayer2365/git-gud)
182197

183198
### LICENSE
184199

185200
New BSD License. See the LICENSE file.
186201

187202
### DEVELOPMENT STATUS
188203

189-
[![codecov](https://codecov.io/gh/gitpython-developers/GitPython/branch/master/graph/badge.svg)](https://codecov.io/gh/gitpython-developers/GitPython)
190-
[![Build Status](https://travis-ci.org/gitpython-developers/GitPython.svg)](https://travis-ci.org/gitpython-developers/GitPython)
191-
[![Build status](https://ci.appveyor.com/api/projects/status/0f3pi3c00hajlrsd/branch/master?svg=true&passingText=windows%20OK&failingText=windows%20failed)](https://ci.appveyor.com/project/Byron/gitpython/branch/master)
192-
[![Code Climate](https://codeclimate.com/github/gitpython-developers/GitPython/badges/gpa.svg)](https://codeclimate.com/github/gitpython-developers/GitPython)
204+
![Python package](https://github.com/gitpython-developers/GitPython/workflows/Python%20package/badge.svg)
193205
[![Documentation Status](https://readthedocs.org/projects/gitpython/badge/?version=stable)](https://readthedocs.org/projects/gitpython/?badge=stable)
194-
[![Stories in Ready](https://badge.waffle.io/gitpython-developers/GitPython.png?label=ready&title=Ready)](https://waffle.io/gitpython-developers/GitPython)
195-
[![Throughput Graph](https://graphs.waffle.io/gitpython-developers/GitPython/throughput.svg)](https://waffle.io/gitpython-developers/GitPython/metrics/throughput)
206+
[![Packaging status](https://repology.org/badge/tiny-repos/python:gitpython.svg)](https://repology.org/metapackage/python:gitpython/versions)
207+
208+
This project is in **maintenance mode**, which means that
196209

197-
Now that there seems to be a massive user base, this should be motivation enough to let git-python
198-
return to a proper state, which means
210+
* …there will be no feature development, unless these are contributed
211+
* …there will be no bug fixes, unless they are relevant to the safety of users, or contributed
212+
* …issues will be responded to with waiting times of up to a month
199213

200-
* no open pull requests
201-
* no open issues describing bugs
214+
The project is open to contributions of all kinds, as well as new maintainers.
202215

203216
[contributing]: https://github.com/gitpython-developers/GitPython/blob/master/CONTRIBUTING.md

‎TODO

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.1.11
1+
3.1.18

‎doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
5+
SPHINXOPTS = -W
66
SPHINXBUILD = sphinx-build
77
PAPER =
88

‎doc/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx<2.0
2+
sphinx_rtd_theme

0 commit comments

Comments
 (0)