code/twython
1
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Begin docs

Browse source 
[ci skip]
This commit is contained in:
Mike Helmick 2013-06-06 13:41:56 -04:00
parent ec2bd7d686
commit 55641a1966
72 changed files with 26300 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

154
docs/_build/html/usage/install.html vendored Normal file
View file

@ -0,0 +1,154 @@
<!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>Installation &mdash; Twython 3.0.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Twython 3.0.0 documentation" href="../index.html" />
<link rel="next" title="Starting Out" href="starting_out.html" />
<link rel="prev" title="Twython" 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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="starting_out.html" title="Starting Out"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../index.html" title="Twython"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Twython 3.0.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installation">
<span id="install"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Information on how to properly install Twython</p>
<div class="section" id="pip-or-easy-install">
<h2>Pip or Easy Install<a class="headerlink" href="#pip-or-easy-install" title="Permalink to this headline"></a></h2>
<p>Install Twython via <a class="reference external" href="http://www.pip-installer.org/">pip</a>:</p>
<div class="highlight-python"><pre>$ pip install twython</pre>
</div>
<p>or, with <a class="reference external" href="http://pypi.python.org/pypi/setuptools">easy_install</a>:</p>
<div class="highlight-python"><pre>$ easy_install twython</pre>
</div>
<p>But, hey... <a class="reference external" href="http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install">that&#8217;s up to you</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>Twython is actively maintained on GitHub</p>
<p>Feel free to clone the repository:</p>
<div class="highlight-python"><pre>git clone git://github.com/ryanmcgrath/twython.git</pre>
</div>
<p><a class="reference external" href="https://github.com/ryanmcgrath/twython/tarball/master">tarball</a>:</p>
<div class="highlight-python"><pre>$ curl -OL https://github.com/ryanmcgrath/twython/tarball/master</pre>
</div>
<p><a class="reference external" href="https://github.com/ryanmcgrath/twython/tarball/master">zipball</a>:</p>
<div class="highlight-python"><pre>$ curl -OL https://github.com/ryanmcgrath/twython/zipball/master</pre>
</div>
<p>Now that you have the source code, install it into your site-packages directory:</p>
<div class="highlight-python"><pre>$ python setup.py install</pre>
</div>
</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 internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#pip-or-easy-install">Pip or Easy Install</a></li>
<li><a class="reference internal" href="#source-code">Source Code</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
title="previous chapter">Twython</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="starting_out.html"
title="next chapter">Starting Out</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/usage/install.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" />
<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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="starting_out.html" title="Starting Out"
>next</a> |</li>
<li class="right" >
<a href="../index.html" title="Twython"
>previous</a> |</li>
<li><a href="../index.html">Twython 3.0.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Ryan McGrath.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>