Commit 1f225d4
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,7 @@ | |||
| 1 | + language: python | ||
| 2 | + python: | ||
| 3 | + - "2.6" | ||
| 4 | + - "2.7" | ||
| 5 | + # - "pypy" - won't work as smmap doesn't work (see gitdb/.travis.yml for details) | ||
| 6 | + | ||
| 7 | + script: nosetests | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,28 +1,27 @@ | |||
| 1 | - ========== | ||
| 2 | - GitPython | ||
| 3 | - ========== | ||
| 1 | + ## GitPython | ||
| 2 | + | ||
| 3 | + .. image:: https://travis-ci.org/gitpython-developers/GitPython.svg?branch=master :target: https://travis-ci.org/gitpython-developers/GitPython | ||
| 4 | 4 | ||
| 5 | 5 | GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. | |
| 6 | 6 | ||
| 7 | 7 | 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. | |
| 8 | 8 | ||
| 9 | 9 | 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. | |
| 10 | 10 | ||
| 11 | - REQUIREMENTS | ||
| 12 | - ============ | ||
| 11 | + ### REQUIREMENTS | ||
| 13 | 12 | ||
| 14 | 13 | * Git ( tested with 1.8.3.4 ) | |
| 15 | 14 | * Python Nose - used for running the tests | |
| 16 | - * Tested with nose 1.3.0 | ||
| 15 | + - Tested with nose 1.3.0 | ||
| 17 | 16 | * Mock by Michael Foord used for tests | |
| 18 | - * Tested with 1.0.1 | ||
| 17 | + - Tested with 1.0.1 | ||
| 18 | + | ||
| 19 | + ### INSTALL | ||
| 19 | 20 | ||
| 20 | - INSTALL | ||
| 21 | - ======= | ||
| 22 | 21 | If you have downloaded the source code: | |
| 23 | 22 | ||
| 24 | 23 | python setup.py install | |
| 25 | - | ||
| 24 | + | ||
| 26 | 25 | or if you want to obtain a copy more easily: | |
| 27 | 26 | ||
| 28 | 27 | pip install gitpython | |
@@ -31,8 +30,8 @@ A distribution package can be obtained for manual installation at: | |||
| 31 | 30 | ||
| 32 | 31 | http://pypi.python.org/pypi/GitPython | |
| 33 | 32 | ||
| 34 | - SOURCE | ||
| 35 | - ====== | ||
| 33 | + ### SOURCE | ||
| 34 | + | ||
| 36 | 35 | ||
| 37 | 36 | GitPython's git repo is available on GitHub, which can be browsed at: | |
| 38 | 37 | ||
@@ -43,23 +42,22 @@ and cloned using: | |||
| 43 | 42 | git clone git://github.com/gitpython-developers/GitPython.git git-python | |
| 44 | 43 | ||
| 45 | 44 | ||
| 46 | - DOCUMENTATION | ||
| 47 | - ============= | ||
| 45 | + ### DOCUMENTATION | ||
| 46 | + | ||
| 48 | 47 | The html-compiled documentation can be found at the following URL: | |
| 49 | 48 | ||
| 50 | 49 | http://packages.python.org/GitPython/ | |
| 51 | 50 | ||
| 52 | - MAILING LIST | ||
| 53 | - ============ | ||
| 51 | + ### MAILING LIST | ||
| 52 | + | ||
| 54 | 53 | http://groups.google.com/group/git-python | |
| 55 | 54 | ||
| 56 | - ISSUE TRACKER | ||
| 57 | - ============= | ||
| 55 | + ### ISSUE TRACKER | ||
| 56 | + | ||
| 58 | 57 | Issues are tracked on github: | |
| 59 | 58 | ||
| 60 | 59 | https://github.com/gitpython-developers/GitPython/issues | |
| 61 | 60 | ||
| 62 | - LICENSE | ||
| 63 | - ======= | ||
| 61 | + ### LICENSE | ||
| 64 | 62 | ||
| 65 | 63 | New BSD License. See the LICENSE file. | |
0 commit comments