Skip to content

Commit 741edb5

Browse files
authored
Merge pull request #1603 from eUgEntOptIc44/eugenoptic44-fix-pypi-long-description
fix pypi long description
2 parents 6fc11e6 + 0c543cd commit 741edb5

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,19 @@ The installer takes care of installing them for you.
5151

5252
If you have downloaded the source code:
5353

54-
python setup.py install
54+
```bash
55+
python setup.py install
56+
```
5557

5658
or if you want to obtain a copy from the Pypi repository:
5759

58-
pip install GitPython
60+
```bash
61+
pip install GitPython
62+
```
5963

6064
Both commands will install the required package dependencies.
6165

62-
A distribution package can be obtained for manual installation at:
63-
64-
http://pypi.python.org/pypi/GitPython
66+
A distribution package can be obtained for manual installation at: <http://pypi.python.org/pypi/GitPython>.
6567

6668
If you like to clone from source, you can do it like so:
6769

@@ -157,15 +159,15 @@ tarballs.
157159
This script shows how to verify the tarball was indeed created by the authors of
158160
this project:
159161

160-
```
162+
```bash
161163
curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl > gitpython.whl
162164
curl https://files.pythonhosted.org/packages/09/bc/ae32e07e89cc25b9e5c793d19a1e5454d30a8e37d95040991160f942519e/GitPython-3.1.8-py3-none-any.whl.asc > gitpython-signature.asc
163165
gpg --verify gitpython-signature.asc gitpython.whl
164166
```
165167

166168
which outputs
167169

168-
```
170+
```bash
169171
gpg: Signature made Fr 4 Sep 10:04:50 2020 CST
170172
gpg: using RSA key 27C50E7F590947D7273A741E85194C08421980C9
171173
gpg: Good signature from "Sebastian Thiel (YubiKey USB-C) <[email protected]>" [ultimate]
@@ -175,19 +177,19 @@ gpg: aka "Sebastian Thiel (In Rust I trust) <sebastian.thiel@icl
175177
You can verify that the keyid indeed matches the release-signature key provided in this
176178
repository by looking at the keys details:
177179

178-
```
180+
```bash
179181
gpg --list-packets ./release-verification-key.asc
180182
```
181183

182184
You can verify that the commit adding it was also signed by it using:
183185

184-
```
186+
```bash
185187
git show --show-signature ./release-verification-key.asc
186188
```
187189

188190
If you would like to trust it permanently, you can import and sign it:
189191

190-
```
192+
```bash
191193
gpg --import ./release-verification-key.asc
192194
gpg --edit-key 4C08421980C9
193195

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def build_py_modules(basedir: str, excludes: Sequence = ()) -> Sequence:
9595
install_requires=requirements,
9696
tests_require=requirements + test_requirements,
9797
zip_safe=False,
98-
long_description="""GitPython is a Python library used to interact with Git repositories""",
98+
long_description=long_description,
9999
long_description_content_type="text/markdown",
100100
classifiers=[
101101
# Picked from

0 commit comments

Comments
 (0)