| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 3aed2ca commit 395b70a
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -17,7 +17,7 @@ probably the skills to scratch that itch of mine: implement `git` in a way that | |||
| 17 | 17 | If you like the idea and want to learn more, please head over to [gitoxide](https://github.com/Byron/gitoxide), an | |
| 18 | 18 | implementation of 'git' in [Rust](https://www.rust-lang.org). | |
| 19 | 19 | ||
| 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.)* | ||
| 21 | 21 | ||
| 22 | 22 | ## GitPython | |
| 23 | 23 | ||
@@ -39,9 +39,9 @@ The project is open to contributions of all kinds, as well as new maintainers. | |||
| 39 | 39 | ||
| 40 | 40 | ### REQUIREMENTS | |
| 41 | 41 | ||
| 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. | ||
| 45 | 45 | ||
| 46 | 46 | - Git (1.7.x or newer) | |
| 47 | 47 | - Python >= 3.7 | |
@@ -57,7 +57,7 @@ GitPython and its required package dependencies can be installed in any of the f | |||
| 57 | 57 | ||
| 58 | 58 | To obtain and install a copy [from PyPI](https://pypi.org/project/GitPython/), run: | |
| 59 | 59 | ||
| 60 | - ```bash | ||
| 60 | + ```sh | ||
| 61 | 61 | pip install GitPython | |
| 62 | 62 | ``` | |
| 63 | 63 | ||
@@ -67,15 +67,15 @@ pip install GitPython | |||
| 67 | 67 | ||
| 68 | 68 | If you have downloaded the source code, run this from inside the unpacked `GitPython` directory: | |
| 69 | 69 | ||
| 70 | - ```bash | ||
| 70 | + ```sh | ||
| 71 | 71 | pip install . | |
| 72 | 72 | ``` | |
| 73 | 73 | ||
| 74 | 74 | #### By cloning the source code repository | |
| 75 | 75 | ||
| 76 | 76 | 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: | |
| 77 | 77 | ||
| 78 | - ```bash | ||
| 78 | + ```sh | ||
| 79 | 79 | git clone https://github.com/gitpython-developers/GitPython | |
| 80 | 80 | cd GitPython | |
| 81 | 81 | ./init-tests-after-clone.sh | |
@@ -85,15 +85,15 @@ On Windows, `./init-tests-after-clone.sh` can be run in a Git Bash shell. | |||
| 85 | 85 | ||
| 86 | 86 | 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`): | |
| 87 | 87 | ||
| 88 | - ```bash | ||
| 88 | + ```sh | ||
| 89 | 89 | gh repo clone GitPython | |
| 90 | 90 | ``` | |
| 91 | 91 | ||
| 92 | 92 | Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html). | |
| 93 | 93 | ||
| 94 | 94 | Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs): | |
| 95 | 95 | ||
| 96 | - ```bash | ||
| 96 | + ```sh | ||
| 97 | 97 | pip install -e ".[test]" | |
| 98 | 98 | ``` | |
| 99 | 99 | ||
@@ -105,7 +105,7 @@ In rare cases, you may want to work on GitPython and one or both of its [gitdb]( | |||
| 105 | 105 | ||
| 106 | 106 | 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: | |
| 107 | 107 | ||
| 108 | - ```bash | ||
| 108 | + ```sh | ||
| 109 | 109 | pip install -e ".[test]" -e git/ext/gitdb -e git/ext/gitdb/gitdb/ext/smmap | |
| 110 | 110 | ``` | |
| 111 | 111 | ||
@@ -141,33 +141,33 @@ you will encounter test failures. | |||
| 141 | 141 | ||
| 142 | 142 | Ensure testing libraries are installed. This is taken care of already if you installed with: | |
| 143 | 143 | ||
| 144 | - ```bash | ||
| 144 | + ```sh | ||
| 145 | 145 | pip install -e ".[test]" | |
| 146 | 146 | ``` | |
| 147 | 147 | ||
| 148 | 148 | Otherwise, you can run: | |
| 149 | 149 | ||
| 150 | - ```bash | ||
| 150 | + ```sh | ||
| 151 | 151 | pip install -r test-requirements.txt | |
| 152 | 152 | ``` | |
| 153 | 153 | ||
| 154 | 154 | #### Test commands | |
| 155 | 155 | ||
| 156 | 156 | To test, run: | |
| 157 | 157 | ||
| 158 | - ```bash | ||
| 158 | + ```sh | ||
| 159 | 159 | pytest | |
| 160 | 160 | ``` | |
| 161 | 161 | ||
| 162 | 162 | To lint, and apply automatic code formatting, run: | |
| 163 | 163 | ||
| 164 | - ```bash | ||
| 164 | + ```sh | ||
| 165 | 165 | pre-commit run --all-files | |
| 166 | 166 | ``` | |
| 167 | 167 | ||
| 168 | 168 | To typecheck, run: | |
| 169 | 169 | ||
| 170 | - ```bash | ||
| 170 | + ```sh | ||
| 171 | 171 | mypy -p git | |
| 172 | 172 | ``` | |
| 173 | 173 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments