← 返回首页
Revise and update the readme by EliahKagan · Pull Request #103 · gitpython-developers/gitdb · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Revise and update the readme #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Byron merged 1 commit into from
Oct 20, 2023
+12 −8
Conversation 1 Commits 1 Checks 0 Files changed 1
Merged

Revise and update the readme #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected Viewed files
Conversations
Failed to load comments. Retry
Loading
Jump to
Jump to file
Failed to load files. Retry
Loading
Diff view
Unified
Split
Hide whitespace
Apply and reload
Show whitespace
Diff view
Unified
Split
Hide whitespace
Apply and reload
20 changes: 12 additions & 8 deletions README.rst
Show comments
View file Edit file Delete file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,38 @@ Installation
:target: https://readthedocs.org/projects/gitdb/?badge=latest
:alt: Documentation Status

From `PyPI <https://pypi.python.org/pypi/gitdb>`_
From `PyPI <https://pypi.python.org/pypi/gitdb>`_::

pip install gitdb

SPEEDUPS
========

If you want to go up to 20% faster, you can install gitdb-speedups with:
If you want to go up to 20% faster, you can install gitdb-speedups with::

pip install gitdb-speedups

However, please note that gitdb-speedups is not currently maintained.

REQUIREMENTS
============

* smmap - declared as a dependency, automatically installed
* pytest - for running the tests

SOURCE
======
The source is available in a git repository at gitorious and github:

The source is available in a git repository on GitHub:

https://github.com/gitpython-developers/gitdb

Once the clone is complete, please be sure to initialize the submodules using
Once the clone is complete, please be sure to initialize the submodule using::

cd gitdb
git submodule update --init

Run the tests with
Run the tests with::

pytest

Expand All @@ -53,13 +57,13 @@ DEVELOPMENT
.. image:: https://github.com/gitpython-developers/gitdb/workflows/Python%20package/badge.svg
:target: https://github.com/gitpython-developers/gitdb/actions

The library is considered mature, and not under active development. It's primary (known) use is in git-python.
The library is considered mature, and not under active development. Its primary (known) use is in GitPython.

INFRASTRUCTURE
==============

* Mailing List
* http://groups.google.com/group/git-python
* Discussions
* https://github.com/gitpython-developers/GitPython/discussions

* Issue Tracker
* https://github.com/gitpython-developers/gitdb/issues
Expand Down
Toggle all file notes Toggle all file annotations

Footer

© 2026 GitHub, Inc.