| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 00aee49 commit 610c46d
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -97,6 +97,20 @@ pip install -e ".[test]" | |||
| 97 | 97 | ||
| 98 | 98 | In the less common case that you do not want to install test dependencies, `pip install -e .` can be used instead. | |
| 99 | 99 | ||
| 100 | + #### With editable *dependencies* (not preferred, and rarely needed) | ||
| 101 | + | ||
| 102 | + In rare cases, you may want to work on GitPython and one or both of its [gitdb](https://github.com/gitpython-developers/gitdb) and [smmap](https://github.com/gitpython-developers/smmap) dependencies at the same time, with changes in your local working copy of gitdb or smmap immediatley reflected in the behavior of your local working copy of GitPython. This can be done by making editable installations of those dependencies in the same virtual environment where you install GitPython. | ||
| 103 | + | ||
| 104 | + 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: | ||
| 105 | + | ||
| 106 | + ```bash | ||
| 107 | + pip install -e ".[test]" -e git/ext/gitdb -e git/ext/gitdb/gitdb/ext/smmap | ||
| 108 | + ``` | ||
| 109 | + | ||
| 110 | + The submodules must have been cloned for that to work, but that will already be the case if you have run `./init-tests-after-clone.sh`. You can use `pip list` to check which packages are installed editably and which are installed normally. | ||
| 111 | + | ||
| 112 | + To reiterate, this approach should only rarely be used. For most development it is preferable to allow the gitdb and smmap dependencices to be retrieved automatically from PyPI in their latest stable packaged versions. | ||
| 113 | + | ||
| 100 | 114 | ### Limitations | |
| 101 | 115 | ||
| 102 | 116 | #### Leakage of System Resources | |
| Back | FazBrowse Home | New Git URL |
0 commit comments