diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2010-07-01 17:58:19 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2010-07-01 17:58:19 +0200 |
| commit | fd96cceded27d1372bdc1a851448d2d8613f60f3 (patch) | |
| tree | 5b53f288a3379e260f46a65d08691fceec4a0ca3 /doc/doc_index/0.2/intro.html | |
| parent | 6917ae4ce9eaa0f5ea91592988c1ea830626ac3a (diff) | |
| parent | c3bd05b426a0e3dec8224244c3c9c0431d1ff130 (diff) | |
| download | GitPython-fd96cceded27d1372bdc1a851448d2d8613f60f3.tar.gz GitPython-fd96cceded27d1372bdc1a851448d2d8613f60f3.zip | |
Merge branch 'docs'
Diffstat (limited to 'doc/doc_index/0.2/intro.html')
| -rw-r--r-- | doc/doc_index/0.2/intro.html | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/doc/doc_index/0.2/intro.html b/doc/doc_index/0.2/intro.html new file mode 100644 index 00000000..2cb9d6dd --- /dev/null +++ b/doc/doc_index/0.2/intro.html @@ -0,0 +1,196 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Overview / Install — GitPython v0.2.0 Beta documentation</title> + <link rel="stylesheet" href="_static/default.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '#', + VERSION: '0.2.0 Beta', + COLLAPSE_MODINDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="top" title="GitPython v0.2.0 Beta documentation" href="index.html" /> + <link rel="next" title="GitPython Tutorial" href="tutorial.html" /> + <link rel="prev" title="GitPython Documentation" href="index.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="tutorial.html" title="GitPython Tutorial" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="index.html" title="GitPython Documentation" + accesskey="P">previous</a> |</li> + <li><a href="index.html">GitPython v0.2.0 Beta documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="overview-install"> +<span id="intro-toplevel"></span><h1>Overview / Install<a class="headerlink" href="#overview-install" title="Permalink to this headline">¶</a></h1> +<p>GitPython is a python library used to interact with Git repositories.</p> +<p>GitPython was a port of the <a class="reference external" href="http://grit.rubyforge.org">grit</a> library in Ruby created by +Tom Preston-Werner and Chris Wanstrath, but grew beyond its heritage through its improved design and performance.</p> +<div class="section" id="requirements"> +<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="http://git-scm.com/">Git</a> tested with 1.5.3.7</li> +<li>Requires <a class="reference external" href="http://git-scm.com/">Git</a> 1.6.5.4 or newer if index.add function is to be used</li> +<li><a class="reference external" href="http://code.google.com/p/python-nose/">Python Nose</a> - used for running the tests</li> +<li><a class="reference external" href="http://www.voidspace.org.uk/python/mock.html">Mock by Michael Foord</a> used for tests. Requires 0.5</li> +</ul> +</div> +<div class="section" id="installing-gitpython"> +<h2>Installing GitPython<a class="headerlink" href="#installing-gitpython" title="Permalink to this headline">¶</a></h2> +<p>Installing GitPython is easily done using +<a class="reference external" href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</a>. Assuming it is +installed, just run the following from the command-line:</p> +<div class="highlight-none"><div class="highlight"><pre># easy_install GitPython +</pre></div> +</div> +<p>This command will download the latest version of GitPython from the +<a class="reference external" href="http://pypi.python.org/pypi/GitPython">Python Package Index</a> and install it +to your system. More information about <tt class="docutils literal"><span class="pre">easy_install</span></tt> and pypi can be found +here:</p> +<ul class="simple"> +<li><a class="reference external" href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</a></li> +<li><a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions">install setuptools</a></li> +<li><a class="reference external" href="http://pypi.python.org/pypi/SQLAlchemy">pypi</a></li> +</ul> +<p>Alternatively, you can install from the distribution using the <tt class="docutils literal"><span class="pre">setup.py</span></tt> +script:</p> +<div class="highlight-none"><div class="highlight"><pre># python setup.py install +</pre></div> +</div> +</div> +<div class="section" id="getting-started"> +<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="tutorial.html#tutorial-label"><em>GitPython Tutorial</em></a> - This tutorial provides a walk-through of some of +the basic functionality and concepts used in GitPython. It, however, is not +exhaustive so you are encouraged to spend some time in the +<a class="reference external" href="reference.html#api-reference-toplevel"><em>API Reference</em></a>.</li> +</ul> +</div> +<div class="section" id="api-reference"> +<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2> +<p>An organized section of the GitPthon API is at <a class="reference external" href="reference.html#api-reference-toplevel"><em>API Reference</em></a>.</p> +</div> +<div class="section" id="source-code"> +<h2>Source Code<a class="headerlink" href="#source-code" title="Permalink to this headline">¶</a></h2> +<p>GitPython’s git repo is available on Gitorious and GitHub, which can be browsed at:</p> +<blockquote> +<ul class="simple"> +<li><a class="reference external" href="http://gitorious.org/projects/git-python/">http://gitorious.org/projects/git-python/</a></li> +<li><a class="reference external" href="http://github.com/Byron/GitPython">http://github.com/Byron/GitPython</a></li> +</ul> +</blockquote> +<p>and cloned using:</p> +<div class="highlight-python"><pre>$ git clone git://gitorious.org/git-python/mainline.git git-python +$ git clone git://github.com/Byron/GitPython.git git-python</pre> +</div> +</div> +<div class="section" id="mailing-list"> +<h2>Mailing List<a class="headerlink" href="#mailing-list" title="Permalink to this headline">¶</a></h2> +<p><a class="reference external" href="http://groups.google.com/group/git-python">http://groups.google.com/group/git-python</a></p> +</div> +<div class="section" id="issue-tracker"> +<h2>Issue Tracker<a class="headerlink" href="#issue-tracker" title="Permalink to this headline">¶</a></h2> +<p><a class="reference external" href="http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones">http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones</a></p> +</div> +<div class="section" id="license-information"> +<h2>License Information<a class="headerlink" href="#license-information" title="Permalink to this headline">¶</a></h2> +<p>GitPython is licensed under the New BSD License. See the LICENSE file for +more information.</p> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference external" href="#">Overview / Install</a><ul> +<li><a class="reference external" href="#requirements">Requirements</a></li> +<li><a class="reference external" href="#installing-gitpython">Installing GitPython</a></li> +<li><a class="reference external" href="#getting-started">Getting Started</a></li> +<li><a class="reference external" href="#api-reference">API Reference</a></li> +<li><a class="reference external" href="#source-code">Source Code</a></li> +<li><a class="reference external" href="#mailing-list">Mailing List</a></li> +<li><a class="reference external" href="#issue-tracker">Issue Tracker</a></li> +<li><a class="reference external" href="#license-information">License Information</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="index.html" + title="previous chapter">GitPython Documentation</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="tutorial.html" + title="next chapter">GitPython Tutorial</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/intro.txt" + rel="nofollow">Show Source</a></li> + </ul> + <div id="searchbox" style="display: none"> + <h3>Quick search</h3> + <form class="search" action="search.html" method="get"> + <input type="text" name="q" size="18" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> + </div> + <script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="tutorial.html" title="GitPython Tutorial" + >next</a> |</li> + <li class="right" > + <a href="index.html" title="GitPython Documentation" + >previous</a> |</li> + <li><a href="index.html">GitPython v0.2.0 Beta documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright Copyright (C) 2008, 2009 Michael Trier and contributors. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5. + </div> + </body> +</html>
\ No newline at end of file |