Mo docs

diogobaeder · Oct 31, 2013 · 0897516 · 0897516
1 parent 77e9886
commit 0897516
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 12 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,9 @@
+Changelog
+=========
+
+0.1.0
+-----
+
+- First version of the library
+- All methods from the SPTrans API implemented
+- Some documentation is still under development
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -0,0 +1,40 @@
+Contributing
+============
+
+First of all, take a look at the repository `here <https://github.com/diogobaeder/sptrans>`_.
+
+You may have noticed that there are two images in the README:
+one that tells the status of the build (via Continuous Integration in `travis-ci <https://travis-ci.org/diogobaeder/sptrans>`_)
+and another that tells the code coverage in `coveralls <https://coveralls.io/r/diogobaeder/sptrans>`_.
+
+This is because I'm a bit obsessive with automated tests, and though I don't think 100% code coverage makes a program free of bugs,
+it does a great job getting as close as possible to this achievement.
+
+By the way, the build doesn't even pass if the production code is not fully covered, so if you want to contribute with it, please
+also add some tests.
+
+Setting up the environment
+--------------------------
+
+1. Make sure you have pip, virtualenv and virtualenvwrapper installed. OK, all of these are optional, but it would be a nice moment
+   for you to start using them if you haven't yet;
+
+2. Create a virtual environment for the project, and activate it;
+
+3. Install the requirements for running the tests:
+
+   .. code-block:: bash
+
+    $ pip install -r requirements.txt
+
+4. Run the tests:
+
+   .. code-block:: bash
+
+    $ tox
+
+   Optionally, you can run the tests with an SPTrans API token, so that the functional tests are also run:
+
+   .. code-block:: bash
+
+    $ SPTRANS_TOKEN=this-is-my-token tox
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,9 @@ Python library for the SPTrans API
    :maxdepth: 4
    :hidden:
 
+   /changelog
    /sptrans
+   /contributing
 
 About
 =====
@@ -63,6 +65,13 @@ As soon as you have the token, use the :class:`client <sptrans.v0.Client>` itsel
 
 Now checkout the other methods available in the :class:`Client <sptrans.v0.Client>` class, to see how the library can help you retrieving data.
 
+Documentation
+=============
+
+* :doc:`changelog`
+* :doc:`library API <sptrans>`
+* :doc:`contributing`
+
 License
 =======
 

diff --git a/requirements.txt b/requirements.txt
@@ -15,8 +15,11 @@ mccabe==0.2.1
 mock==1.0.1
 nose==1.3.0
 pep8==1.4.6
+py==1.4.18
 pyflakes==0.7.3
 requests==2.0.0
 sh==1.09
+tox==1.6.1
+virtualenv==1.10.1
 xtraceback==0.3.3
 yanc==0.2.4