|
| 1 | +# Archive Notice |
| 2 | + |
| 3 | +The entire history of this repository is now contained in https://github.com/gitpython-developers/GitPython, where it is now maintained. |
| 4 | +For issues, please use its issue tracker as well. |
| 5 | + |
| 6 | +# GitDB |
| 7 | + |
| 8 | +GitDB allows you to access bare git repositories for reading and writing. It aims at allowing full access to loose objects as well as packs with performance and scalability in mind. It operates exclusively on streams, allowing to handle large objects with a small memory footprint. |
| 9 | + |
| 10 | +## Installation |
| 11 | + |
| 12 | +[](https://pypi.python.org/pypi/gitdb/) |
| 13 | +[](https://pypi.python.org/pypi/gitdb/) |
| 14 | +[](https://readthedocs.org/projects/gitdb/?badge=latest) |
| 15 | + |
| 16 | +From [PyPI](https://pypi.python.org/pypi/gitdb): |
| 17 | + |
| 18 | +```shell |
| 19 | +pip install gitdb |
| 20 | +``` |
| 21 | + |
| 22 | +## Speedups |
| 23 | + |
| 24 | +If you want to go up to 20% faster, you can install gitdb-speedups with: |
| 25 | + |
| 26 | +```shell |
| 27 | +pip install gitdb-speedups |
| 28 | +``` |
| 29 | + |
| 30 | +However, please note that gitdb-speedups is not currently maintained. |
| 31 | + |
| 32 | +## Requirements |
| 33 | + |
| 34 | +* smmap — declared as a dependency, automatically installed |
| 35 | +* pytest — for running the tests |
| 36 | + |
| 37 | +## Source |
| 38 | + |
| 39 | +The source is available in a git repository on GitHub: |
| 40 | + |
| 41 | +https://github.com/gitpython-developers/gitdb |
| 42 | + |
| 43 | +Once the clone is complete, please be sure to initialize the submodule using: |
| 44 | + |
| 45 | +```shell |
| 46 | +cd gitdb |
| 47 | +git submodule update --init |
| 48 | +``` |
| 49 | + |
| 50 | +Run the tests with: |
| 51 | + |
| 52 | +```shell |
| 53 | +pytest |
| 54 | +``` |
| 55 | + |
| 56 | +## Development |
| 57 | + |
| 58 | +[](https://github.com/gitpython-developers/gitdb/actions) |
| 59 | + |
| 60 | +The library is considered mature, and not under active development. Its primary (known) use is in GitPython. |
| 61 | + |
| 62 | +## Infrastructure |
| 63 | + |
| 64 | +* Discussions |
| 65 | + * https://github.com/gitpython-developers/GitPython/discussions |
| 66 | +* Issue Tracker |
| 67 | + * https://github.com/gitpython-developers/gitdb/issues |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +New BSD License |
0 commit comments