update docs before release

Author: skasberger

src/pyDataverse/docs/source/developer.rst

@@ -31,13 +31,17 @@ Exceptions
 Install
 -----------------------------
 
-Install from the local git repository:
+Install from the local git repository, with all it's dependencies:
 
 .. code-block:: shell
 
     virtualenv venv
     source venv/bin/activate
-    pip install -r requirements.txt
+    pip install -r tools/tests-requirements.txt
+    pip install -r tools/lint-requirements.txt
+    pip install -r tools/docs-requirements.txt
+    pip install -r tools/packaging-requirements.txt
+    pip install -e .
 
 
 Testing
@@ -80,6 +84,8 @@ When you only want to run one test, e.g. the py36 test:
 
     tox -e py36
 
+To find out more about which tests are available, have a look inside the tox.ini file.
+
 
 Documentation
 -----------------------------

src/pyDataverse/docs/source/index.rst

@@ -3,6 +3,24 @@ pyDataverse
 
 Release v\ |version|.
 
+.. image:: https://travis-ci.com/AUSSDA/pyDataverse.svg?branch=master
+    :target: https://travis-ci.com/AUSSDA/pyDataverse
+
+.. image:: https://img.shields.io/pypi/v/pyDataverse.svg
+    :target: https://pypi.org/project/pyDataverse/
+
+.. image:: https://img.shields.io/pypi/wheel/pyDataverse.svg
+    :target: https://pypi.org/project/pyDataverse/
+
+.. image:: https://img.shields.io/pypi/pyversions/pyDataverse.svg
+    :target: https://pypi.org/project/pyDataverse/
+
+.. image:: https://readthedocs.org/projects/pydataverse/badge/?version=latest
+    :target: https://pydataverse.readthedocs.io/en/latest
+
+.. image:: https://coveralls.io/repos/github/AUSSDA/pyDataverse/badge.svg
+    :target: https://coveralls.io/github/AUSSDA/pyDataverse
+
 .. image:: https://img.shields.io/github/license/aussda/pydataverse.svg
     :target: https://opensource.org/licenses/MIT
 
@@ -27,28 +45,26 @@ Quickstart
 
 **Usage**
 
-.. code-block:: python
-
-    >>> from pyDataverse.api import Api
-    >>> # establish connection
-    >>> base_url = 'http://demo.dataverse.org'
-    >>> api = Api(base_url)
-    >>> api.status
-    'OK'
-    >>> # get dataverse
-    >>> dv = 'ecastro'  # dataverse alias or id
-    >>> resp = api.get_dataverse(dv)
-    >>> resp.json()['data']['creationDate']
-    '2015-04-20T09:29:39Z'
-    >>> # get dataset
-    >>> resp = api.get_dataset(identifier)
-    >>> resp.json()['data']['id']
-    24
-    >>> # get datafile
-    >>> datafile_id = '32'  # file id of the datafile
-    >>> resp = api.get_datafile(datafile_id)
-    >>> resp
-    <Response [200]>
+>>> from pyDataverse.api import Api
+>>> # establish connection
+>>> base_url = 'http://demo.dataverse.org'
+>>> api = Api(base_url)
+>>> api.status
+'OK'
+>>> # get dataverse
+>>> dv = 'ecastro'  # dataverse alias or id
+>>> resp = api.get_dataverse(dv)
+>>> resp.json()['data']['creationDate']
+'2015-04-20T09:29:39Z'
+>>> # get dataset
+>>> resp = api.get_dataset(identifier)
+>>> resp.json()['data']['id']
+24
+>>> # get datafile
+>>> datafile_id = '32'  # file id of the datafile
+>>> resp = api.get_datafile(datafile_id)
+>>> resp
+<Response [200]>
 
 
 Requirements