Skip to content

Commit 28a33ca

Browse files
committed
Added further information about the required submodules, and how to install them. Incremeneted version to 0.3.0 beta1
1 parent fde6522 commit 28a33ca

File tree

5 files changed

+34
-15
lines changed

5 files changed

+34
-15
lines changed

Diff for: VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.0-beta1
1+
0.3.0-beta1

Diff for: doc/conf.py

+4
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@
9292
# Options for HTML output
9393
# -----------------------
9494

95+
html_theme_options = {
96+
"stickysidebar": "true"
97+
}
98+
9599
# The style sheet to use for HTML and HTML Help pages. A file of that name
96100
# must exist either in Sphinx' static/ path, or in one of the custom paths
97101
# given in html_static_path.

Diff for: doc/intro.rst

+23-2
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,21 @@ The object database implementation is optimized for handling large quantities of
1313
Requirements
1414
============
1515

16-
* Tested with `Git`_ 1.7.0 or newer
16+
* `Git`_ 1.7.0 or newer
17+
It should also work with older versions, but it may be that some operations
18+
involving remotes will not work as expected.
19+
* `GitDB`_ - a pure python git database implementation
20+
21+
* `async`_ - asynchronous task scheduling
22+
1723
* `Python Nose`_ - used for running the tests
1824
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
1925

2026
.. _Git: http://git-scm.com/
2127
.. _Python Nose: http://code.google.com/p/python-nose/
2228
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
29+
.. _GitDB: http://pypi.python.org/pypi/gitdb
30+
.. _async: http://pypi.python.org/pypi/async
2331

2432
Installing GitPython
2533
====================
@@ -49,6 +57,8 @@ script:
4957
.. sourcecode:: none
5058

5159
# python setup.py install
60+
61+
.. note:: In this case, you have to manually install `GitDB`_ and `async`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case.
5262

5363
Getting Started
5464
===============
@@ -63,6 +73,8 @@ API Reference
6373

6474
An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
6575

76+
.. _source-code-label:
77+
6678
Source Code
6779
===========
6880

@@ -75,7 +87,16 @@ and cloned using::
7587

7688
$ git clone git://gitorious.org/git-python/mainline.git git-python
7789
$ git clone git://github.com/Byron/GitPython.git git-python
78-
90+
91+
Initialize all submodules to obtain the required dependencies with::
92+
93+
$ cd git-python
94+
$ git submodule update --init --recursive
95+
96+
Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests::
97+
98+
$ nosetests
99+
79100
Mailing List
80101
============
81102
http://groups.google.com/group/git-python

Diff for: lib/git/ext/gitdb

Submodule gitdb updated from c265c97 to 7562fdd

Diff for: setup.py

100644100755
+5-11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#!/usr/bin/env python
12
try:
23
from setuptools import setup, find_packages
34
except ImportError:
@@ -54,22 +55,15 @@ def _stamp_version(filename):
5455
cmdclass={'build_py': build_py, 'sdist': sdist},
5556
version = VERSION,
5657
description = "Python Git Library",
57-
author = "Michael Trier",
58-
author_email = "[email protected]",
58+
author = "Sebastian Thiel, Michael Trier",
59+
5960
url = "http://gitorious.org/projects/git-python/",
6061
packages = find_packages('lib'),
6162
package_dir = {'':'lib'},
6263
license = "BSD License",
64+
requires=('gitdb (>=0.5)',),
6365
long_description = """\
64-
GitPython is a python library used to interact with Git repositories.
65-
66-
GitPython provides object model access to your git repository. Once you have
67-
created a repository object, you can traverse it to find parent commit(s),
68-
trees, blobs, etc.
69-
70-
GitPython is a port of the grit library in Ruby created by
71-
Tom Preston-Werner and Chris Wanstrath.
72-
""",
66+
GitPython is a python library used to interact with Git repositories""",
7367
classifiers = [
7468
"Development Status :: 4 - Beta",
7569
"Intended Audience :: Developers",

0 commit comments

Comments
 (0)