| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1 +1 @@ | |||
| 1 | - 0.2.0-beta1 | ||
| 1 | + 0.3.0-beta1 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -92,6 +92,10 @@ | |||
| 92 | 92 | # Options for HTML output | |
| 93 | 93 | # ----------------------- | |
| 94 | 94 | ||
| 95 | + html_theme_options = { | ||
| 96 | + "stickysidebar": "true" | ||
| 97 | + } | ||
| 98 | + | ||
| 95 | 99 | # The style sheet to use for HTML and HTML Help pages. A file of that name | |
| 96 | 100 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
| 97 | 101 | # given in html_static_path. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -13,13 +13,21 @@ The object database implementation is optimized for handling large quantities of | |||
| 13 | 13 | Requirements | |
| 14 | 14 | ============ | |
| 15 | 15 | ||
| 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 | + | ||
| 17 | 23 | * `Python Nose`_ - used for running the tests | |
| 18 | 24 | * `Mock by Michael Foord`_ used for tests. Requires version 0.5 | |
| 19 | 25 | ||
| 20 | 26 | .. _Git: http://git-scm.com/ | |
| 21 | 27 | .. _Python Nose: http://code.google.com/p/python-nose/ | |
| 22 | 28 | .. _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 | ||
| 23 | 31 | ||
| 24 | 32 | Installing GitPython | |
| 25 | 33 | ==================== | |
@@ -49,6 +57,8 @@ script: | |||
| 49 | 57 | .. sourcecode:: none | |
| 50 | 58 | ||
| 51 | 59 | # 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. | ||
| 52 | 62 | ||
| 53 | 63 | Getting Started | |
| 54 | 64 | =============== | |
@@ -63,6 +73,8 @@ API Reference | |||
| 63 | 73 | ||
| 64 | 74 | An organized section of the GitPthon API is at :ref:`api_reference_toplevel`. | |
| 65 | 75 | ||
| 76 | + .. _source-code-label: | ||
| 77 | + | ||
| 66 | 78 | Source Code | |
| 67 | 79 | =========== | |
| 68 | 80 | ||
@@ -75,7 +87,16 @@ and cloned using:: | |||
| 75 | 87 | ||
| 76 | 88 | $ git clone git://gitorious.org/git-python/mainline.git git-python | |
| 77 | 89 | $ 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 | + | ||
| 79 | 100 | Mailing List | |
| 80 | 101 | ============ | |
| 81 | 102 | http://groups.google.com/group/git-python | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,3 +1,4 @@ | |||
| 1 | + #!/usr/bin/env python | ||
| 1 | 2 | try: | |
| 2 | 3 | from setuptools import setup, find_packages | |
| 3 | 4 | except ImportError: | |
@@ -54,22 +55,15 @@ def _stamp_version(filename): | |||
| 54 | 55 | cmdclass={'build_py': build_py, 'sdist': sdist}, | |
| 55 | 56 | version = VERSION, | |
| 56 | 57 | description = "Python Git Library", | |
| 57 | - author = "Michael Trier", | ||
| 58 | - author_email = "mtrier@gmail.com", | ||
| 58 | + author = "Sebastian Thiel, Michael Trier", | ||
| 59 | + author_email = "byronimo@gmail.com, mtrier@gmail.com", | ||
| 59 | 60 | url = "http://gitorious.org/projects/git-python/", | |
| 60 | 61 | packages = find_packages('lib'), | |
| 61 | 62 | package_dir = {'':'lib'}, | |
| 62 | 63 | license = "BSD License", | |
| 64 | + requires=('gitdb (>=0.5)',), | ||
| 63 | 65 | 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""", | ||
| 73 | 67 | classifiers = [ | |
| 74 | 68 | "Development Status :: 4 - Beta", | |
| 75 | 69 | "Intended Audience :: Developers", | |
| Back | FazBrowse Home | New Git URL |
0 commit comments