diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2014-11-14 15:28:03 +0100 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2014-11-14 15:28:03 +0100 |
| commit | cebda2d5941410cad07b30c4e6b3fc1823d593a4 (patch) | |
| tree | 0347791e8be91e6b6c978e91d1546eb4dfcfd11a | |
| parent | 3c7ec9d8dfcbc7863f69941683dcac8f8e416f7d (diff) | |
| download | gitpython-cebda2d5941410cad07b30c4e6b3fc1823d593a4.tar.gz | |
Added deprecation warning to master branch
| -rw-r--r-- | README.rst | 74 |
1 files changed, 6 insertions, 68 deletions
@@ -1,71 +1,9 @@ -========== -GitPython -========== +=================== +DEPRECATION WARNING +=================== -GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. +This branch contains an abandoned experiment which aimed to change the architecture of git-python entirely. However, as it was never finished, it was good for quite a bit of confusion only. -It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation. +For the most recent state, please refer to the default branch you find on github. -The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming. - -REQUIREMENTS -============ - -* Git ( tested with 1.8.3.4 ) -* Python Nose - used for running the tests - * Tested with nose 1.3.0 -* Mock by Michael Foord used for tests - * Tested with 1.0.1 - -INSTALL -======= -If you have downloaded the source code: - -.. code-block:: console - - $ python setup.py install - -or if you want to obtain a copy more easily: - -.. code-block:: console - - $ easy_install gitpython - -A distribution package can be obtained for manual installation at: - -http://pypi.python.org/pypi/GitPython - -SOURCE -====== - -GitPython's git repo is available on GitHub, which can be browsed at: - -https://github.com/gitpython-developers/GitPython - -and cloned using: - -.. code-block:: console - - $ git clone git://github.com/gitpython-developers/GitPython.git git-python - - -DOCUMENTATION -============= -The html-compiled documentation can be found at the following URL: - -http://packages.python.org/GitPython/ - -MAILING LIST -============ -http://groups.google.com/group/git-python - -ISSUE TRACKER -============= -Issues are tracked on github: - -https://github.com/gitpython-developers/GitPython/issues - -LICENSE -======= - -New BSD License. See the LICENSE file. +Thank you. |