FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Added downloadable versions of the respective documentation, which sh… · pythonthings/GitPython@a98e0af · GitHub

  1. pythonthings
  2. GitPython

Repository navigation

Commit a98e0af

Browse files
Byron
committed
Added downloadable versions of the respective documentation, which should aid packagers a bit
1 parent 96c7ac2 commit a98e0af

34 files changed

Lines changed: 11058 additions & 5 deletions

‎doc/doc_index/0.1/docs_0.1.zip‎

59.5 KB
Binary file not shown.

‎doc/doc_index/0.2/docs_0.2.zip‎

91.9 KB
Binary file not shown.

‎doc/doc_index/0.3.0/docs_0.3.0.zip‎

122 KB
Binary file not shown.

‎doc/doc_index/0.3.1/_sources/changes.txt‎

Lines changed: 413 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/doc_index/0.3.1/_sources/index.txt‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. GitPython documentation master file, created by sphinx-quickstart on Sat Jan 24 11:51:01 2009.
2+
You can adapt this file completely to your liking, but it should at least
3+
contain the root `toctree` directive.
4+
5+
GitPython Documentation
6+
=======================
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
11+
intro
12+
whatsnew
13+
tutorial
14+
reference
15+
roadmap
16+
changes
17+
18+
Indices and tables
19+
==================
20+
21+
* :ref:`genindex`
22+
* :ref:`modindex`
23+
* :ref:`search`
24+

‎doc/doc_index/0.3.1/_sources/intro.txt‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.. _intro_toplevel:
2+
3+
==================
4+
Overview / Install
5+
==================
6+
7+
GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing.
8+
9+
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.
10+
11+
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.
12+
13+
Requirements
14+
============
15+
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+
23+
* `Python Nose`_ - used for running the tests
24+
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
25+
26+
.. _Git: http://git-scm.com/
27+
.. _Python Nose: http://code.google.com/p/python-nose/
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
31+
32+
Installing GitPython
33+
====================
34+
35+
Installing GitPython is easily done using
36+
`setuptools`_. Assuming it is
37+
installed, just run the following from the command-line:
38+
39+
.. sourcecode:: none
40+
41+
# easy_install GitPython
42+
43+
This command will download the latest version of GitPython from the
44+
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
45+
to your system. More information about ``easy_install`` and pypi can be found
46+
here:
47+
48+
* `setuptools`_
49+
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
50+
* `pypi <http://pypi.python.org/pypi/SQLAlchemy>`_
51+
52+
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
53+
54+
Alternatively, you can install from the distribution using the ``setup.py``
55+
script:
56+
57+
.. sourcecode:: none
58+
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.
62+
63+
Getting Started
64+
===============
65+
66+
* :ref:`tutorial-label` - This tutorial provides a walk-through of some of
67+
the basic functionality and concepts used in GitPython. It, however, is not
68+
exhaustive so you are encouraged to spend some time in the
69+
:ref:`api_reference_toplevel`.
70+
71+
API Reference
72+
=============
73+
74+
An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
75+
76+
.. _source-code-label:
77+
78+
Source Code
79+
===========
80+
81+
GitPython's git repo is available on GitHub, which can be browsed at:
82+
83+
* https://github.com/gitpython-developers/GitPython
84+
85+
and cloned using::
86+
87+
$ git clone git://github.com/gitpython-developers/GitPython.git git-python
88+
89+
Initialize all submodules to obtain the required dependencies with::
90+
91+
$ cd git-python
92+
$ git submodule update --init --recursive
93+
94+
Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests::
95+
96+
$ nosetests
97+
98+
Mailing List
99+
============
100+
http://groups.google.com/group/git-python
101+
102+
Issue Tracker
103+
=============
104+
The issue tracker is hosted by github:
105+
106+
https://github.com/gitpython-developers/GitPython/issues
107+
108+
License Information
109+
===================
110+
GitPython is licensed under the New BSD License. See the LICENSE file for
111+
more information.
112+

‎doc/doc_index/0.3.1/_sources/reference.txt‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
.. _api_reference_toplevel:
2+
3+
API Reference
4+
=============
5+
6+
Objects.Base
7+
------------
8+
9+
.. automodule:: git.objects.base
10+
:members:
11+
:undoc-members:
12+
13+
Objects.Blob
14+
------------
15+
16+
.. automodule:: git.objects.blob
17+
:members:
18+
:undoc-members:
19+
20+
Objects.Commit
21+
--------------
22+
23+
.. automodule:: git.objects.commit
24+
:members:
25+
:undoc-members:
26+
27+
Objects.Tag
28+
-----------
29+
30+
.. automodule:: git.objects.tag
31+
:members:
32+
:undoc-members:
33+
34+
Objects.Tree
35+
------------
36+
37+
.. automodule:: git.objects.tree
38+
:members:
39+
:undoc-members:
40+
41+
Objects.Functions
42+
-----------------
43+
44+
.. automodule:: git.objects.fun
45+
:members:
46+
:undoc-members:
47+
48+
Objects.Submodule.base
49+
----------------------
50+
51+
.. automodule:: git.objects.submodule.base
52+
:members:
53+
:undoc-members:
54+
55+
Objects.Submodule.root
56+
----------------------
57+
58+
.. automodule:: git.objects.submodule.root
59+
:members:
60+
:undoc-members:
61+
62+
Objects.Submodule.util
63+
----------------------
64+
65+
.. automodule:: git.objects.submodule.util
66+
:members:
67+
:undoc-members:
68+
69+
Objects.Util
70+
-------------
71+
72+
.. automodule:: git.objects.util
73+
:members:
74+
:undoc-members:
75+
76+
Index.Base
77+
----------
78+
79+
.. automodule:: git.index.base
80+
:members:
81+
:undoc-members:
82+
83+
Index.Functions
84+
---------------
85+
86+
.. automodule:: git.index.fun
87+
:members:
88+
:undoc-members:
89+
90+
Index.Types
91+
-----------
92+
93+
.. automodule:: git.index.typ
94+
:members:
95+
:undoc-members:
96+
97+
Index.Util
98+
-------------
99+
100+
.. automodule:: git.index.util
101+
:members:
102+
:undoc-members:
103+
104+
GitCmd
105+
------
106+
107+
.. automodule:: git.cmd
108+
:members:
109+
:undoc-members:
110+
111+
112+
Config
113+
------
114+
115+
.. automodule:: git.config
116+
:members:
117+
:undoc-members:
118+
119+
Diff
120+
----
121+
122+
.. automodule:: git.diff
123+
:members:
124+
:undoc-members:
125+
126+
Exceptions
127+
----------
128+
129+
.. automodule:: git.exc
130+
:members:
131+
:undoc-members:
132+
133+
134+
Refs.symbolic
135+
-------------
136+
137+
.. automodule:: git.refs.symbolic
138+
:members:
139+
:undoc-members:
140+
141+
Refs.reference
142+
--------------
143+
144+
.. automodule:: git.refs.reference
145+
:members:
146+
:undoc-members:
147+
148+
Refs.head
149+
---------
150+
151+
.. automodule:: git.refs.head
152+
:members:
153+
:undoc-members:
154+
155+
Refs.tag
156+
------------
157+
158+
.. automodule:: git.refs.tag
159+
:members:
160+
:undoc-members:
161+
162+
Refs.remote
163+
------------
164+
165+
.. automodule:: git.refs.remote
166+
:members:
167+
:undoc-members:
168+
169+
Refs.log
170+
------------
171+
172+
.. automodule:: git.refs.log
173+
:members:
174+
:undoc-members:
175+
176+
Remote
177+
------
178+
179+
.. automodule:: git.remote
180+
:members:
181+
:undoc-members:
182+
183+
Repo.Base
184+
---------
185+
186+
.. automodule:: git.repo.base
187+
:members:
188+
:undoc-members:
189+
190+
Repo.Functions
191+
--------------
192+
193+
.. automodule:: git.repo.fun
194+
:members:
195+
:undoc-members:
196+
197+
Util
198+
----
199+
200+
.. automodule:: git.util
201+
:members:
202+
:undoc-members:

‎doc/doc_index/0.3.1/_sources/roadmap.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
#######
3+
Roadmap
4+
#######
5+
The full list of milestones including associated tasks can be found on github:
6+
https://github.com/gitpython-developers/GitPython/issues
7+
8+
Select the respective milestone to filter the list of issues accordingly.
9+

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL