Skip to content

Commit 395b70a

Browse files
committed
Very slightly improve readme presentation
- Add a missing period. - Indicate sh rather than bash as as the language for syntax highlighting of shell commands that don't need bash. I had held off on making that second change in previous revisions because it would have involved either introducing an inconsistency or editing the section giving the deprecated signature-checking instructions. That section was removed in 2671167 (gitpython-developers#1823). (This also wraps a paragraph where the immediately surrounding text was wrapped, but that should not affect rendered text, and broader consistency improvements to Markdown wrapping style are not done.)
1 parent 3aed2ca commit 395b70a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

Diff for: README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ probably the skills to scratch that itch of mine: implement `git` in a way that
1717
If you like the idea and want to learn more, please head over to [gitoxide](https://github.com/Byron/gitoxide), an
1818
implementation of 'git' in [Rust](https://www.rust-lang.org).
1919

20-
*(Please note that `gitoxide` is not currently available for use in Python, and that Rust is required)*
20+
*(Please note that `gitoxide` is not currently available for use in Python, and that Rust is required.)*
2121

2222
## GitPython
2323

@@ -39,9 +39,9 @@ The project is open to contributions of all kinds, as well as new maintainers.
3939

4040
### REQUIREMENTS
4141

42-
GitPython needs the `git` executable to be installed on the system and available in your `PATH` for most operations.
43-
If it is not in your `PATH`, you can help GitPython find it by setting
44-
the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
42+
GitPython needs the `git` executable to be installed on the system and available in your
43+
`PATH` for most operations. If it is not in your `PATH`, you can help GitPython find it
44+
by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
4545

4646
- Git (1.7.x or newer)
4747
- Python >= 3.7
@@ -57,7 +57,7 @@ GitPython and its required package dependencies can be installed in any of the f
5757

5858
To obtain and install a copy [from PyPI](https://pypi.org/project/GitPython/), run:
5959

60-
```bash
60+
```sh
6161
pip install GitPython
6262
```
6363

@@ -67,15 +67,15 @@ pip install GitPython
6767

6868
If you have downloaded the source code, run this from inside the unpacked `GitPython` directory:
6969

70-
```bash
70+
```sh
7171
pip install .
7272
```
7373

7474
#### By cloning the source code repository
7575

7676
To clone the [the GitHub repository](https://github.com/gitpython-developers/GitPython) from source to work on the code, you can do it like so:
7777

78-
```bash
78+
```sh
7979
git clone https://github.com/gitpython-developers/GitPython
8080
cd GitPython
8181
./init-tests-after-clone.sh
@@ -85,15 +85,15 @@ On Windows, `./init-tests-after-clone.sh` can be run in a Git Bash shell.
8585

8686
If you are cloning [your own fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks), then replace the above `git clone` command with one that gives the URL of your fork. Or use this [`gh`](https://cli.github.com/) command (assuming you have `gh` and your fork is called `GitPython`):
8787

88-
```bash
88+
```sh
8989
gh repo clone GitPython
9090
```
9191

9292
Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html).
9393

9494
Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
9595

96-
```bash
96+
```sh
9797
pip install -e ".[test]"
9898
```
9999

@@ -105,7 +105,7 @@ In rare cases, you may want to work on GitPython and one or both of its [gitdb](
105105

106106
If you want to do that *and* you want the versions in GitPython's git submodules to be used, then pass `-e git/ext/gitdb` and/or `-e git/ext/gitdb/gitdb/ext/smmap` to `pip install`. This can be done in any order, and in separate `pip install` commands or the same one, so long as `-e` appears before *each* path. For example, you can install GitPython, gitdb, and smmap editably in the currently active virtual environment this way:
107107

108-
```bash
108+
```sh
109109
pip install -e ".[test]" -e git/ext/gitdb -e git/ext/gitdb/gitdb/ext/smmap
110110
```
111111

@@ -141,33 +141,33 @@ you will encounter test failures.
141141

142142
Ensure testing libraries are installed. This is taken care of already if you installed with:
143143

144-
```bash
144+
```sh
145145
pip install -e ".[test]"
146146
```
147147

148148
Otherwise, you can run:
149149

150-
```bash
150+
```sh
151151
pip install -r test-requirements.txt
152152
```
153153

154154
#### Test commands
155155

156156
To test, run:
157157

158-
```bash
158+
```sh
159159
pytest
160160
```
161161

162162
To lint, and apply automatic code formatting, run:
163163

164-
```bash
164+
```sh
165165
pre-commit run --all-files
166166
```
167167

168168
To typecheck, run:
169169

170-
```bash
170+
```sh
171171
mypy -p git
172172
```
173173

0 commit comments

Comments
 (0)