aboutsummaryrefslogtreecommitdiffstats
path: root/docs/installation.rst
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-02-29 01:22:16 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-02-29 01:22:16 +0100
commitd5a26bd35820b1cb3de991fd45460345b9d3f492 (patch)
treedb935b1c504b86b4208946f9e15c3d89b04611db /docs/installation.rst
parentRepos.watchers service done (diff)
downloadpython-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.tar.xz
python-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.zip
Init documentation
+core +services.user ~services.repos
Diffstat (limited to 'docs/installation.rst')
-rw-r--r--docs/installation.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000..8ed6c10
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,29 @@
+Installation
+=============
+::
+
+ pip install pygithub3
+
+ or
+
+ easy_install pygithub3
+
+
+Dependencies
+---------------
+
+Required
+.........
+
+This library only depends on `request library`_ module.
+
+If you install ``pygithub3`` with ``pip`` all is done. The best option
+
+Optional
+.........
+
+If you want to run the test suite, you must install `nose`_ and `mock`_
+
+.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html
+.. _nose: http://readthedocs.org/docs/nose/en/latest
+.. _mock: http://pypi.python.org/pypi/mock