update pyDataverse version to v0.2.0; update docs

HISTORY.md

@@ -1,11 +1,16 @@
 .. :changelog:
 
+0.2.0 - (2019-06-17) - Ida Pfeiffer
+------------------------------------
+
+[Release](https://github.com/AUSSDA/pyDataverse/releases/tag/v0.2.0)
+
 0.1.1 - (2019-05-28)
 ------------------------------------
 
 [Release](https://github.com/AUSSDA/pyDataverse/releases/tag/v0.1.1)
 
-0.1.0 - Marietta Blau (2019-05-20)
+0.1.0 - (2019-05-20) - Marietta Blau
 ------------------------------------
 
 [Release](https://github.com/AUSSDA/pyDataverse/releases/tag/v0.1.0)

src/pyDataverse/__init__.py

@@ -16,7 +16,7 @@
 __email__ = '[email protected]'
 __copyright__ = 'Copyright (c) 2019 Stefan Kasberger'
 __license__ = 'MIT License'
-__version__ = '0.1.1'
+__version__ = '0.2.0'
 __url__ = 'https://github.com/AUSSDA/pyDataverse'
 __download_url__ = 'https://pypi.python.org/pypi/pyDataverse'
-__description__ = 'A Python wrapper around the Dataverse API'
+__description__ = 'A Python module for Dataverse.'

src/pyDataverse/docs/source/developer.rst

@@ -95,19 +95,6 @@ When you only want to run one test, e.g. the py36 test:
 
 To find out more about which tests are available, have a look inside the tox.ini file.
 
-
-Documentation
------------------------------
-
-
-**Create Sphinx Docs**
-
-Use Sphinx to create class and function documentation out of the doc-strings. You can call it via `tox`. This creates the created docs inside `docs/build`.
-
-.. code-block:: shell
-
-    tox -e docs
-
 **Create Coverage Reports**
 
 Run tests with coverage to create html and xml reports as an output. Again, call it via `tox`. This creates the created docs inside `docs/coverage_html/`.
@@ -123,3 +110,15 @@ To use Coveralls on local development:
 .. code-block:: shell
 
     tox -e coveralls
+
+Documentation
+-----------------------------
+
+
+**Create Sphinx Docs**
+
+Use Sphinx to create class and function documentation out of the doc-strings. You can call it via `tox`. This creates the created docs inside `docs/build`.
+
+.. code-block:: shell
+
+    tox -e docs

src/pyDataverse/docs/source/index.rst

@@ -27,9 +27,9 @@ Release v\ |version|.
 -------------------
 
 pyDataverse is a Python module for `Dataverse <http://dataverse.org>`_.
-It uses the `Native API <http://guides.dataverse.org/en/latest/api/native-api.html>`_
-and `Data Access API <http://guides.dataverse.org/en/latest/api/dataaccess.html>`_
-to create, update and remove Dataverses, Datasets and Datafiles.
+It uses the `Dataverse API <http://guides.dataverse.org/en/latest/api/index.html>`_
+and it's metadata model to import, manipulate and export Dataverses, Datasets
+and Datafiles.
 
 -------------------
 
@@ -46,22 +46,24 @@ Quickstart
 **Usage**
 
 >>> from pyDataverse.api import Api
+>>> from pyDataverse.models import Dataverse
 >>> # establish connection
->>> base_url = 'http://demo.dataverse.org'
+>>> base_url = 'https://data.aussda.at/'
 >>> api = Api(base_url)
 >>> api.status
 'OK'
 >>> # get dataverse
->>> dv = 'ecastro'  # dataverse alias or id
+>>> dv = 'autnes'  # dataverse alias or id
 >>> resp = api.get_dataverse(dv)
 >>> resp.json()['data']['creationDate']
-'2015-04-20T09:29:39Z'
+'2017-11-09T13:53:27Z'
 >>> # get dataset
+>>> identifier = 'doi:10.11587/IMKDZI'
 >>> resp = api.get_dataset(identifier)
 >>> resp.json()['data']['id']
-24
+345
 >>> # get datafile
->>> datafile_id = '32'  # file id of the datafile
+>>> datafile_id = '399'  # file id of the datafile
 >>> resp = api.get_datafile(datafile_id)
 >>> resp
 <Response [200]>
@@ -80,10 +82,10 @@ External packages:
 Features
 -----------------------------
 
-- Dataverse Api functionalities to create, get, publish and delete Dataverses, Datasets and Datafiles.
-- Dataverse data model for easy manipulation and data conversion.
-- Utils to support the core functionalities.
-- Custom exceptions
+- Dataverse Api functionalities to create, get, publish and delete Dataverses, Datasets and Datafiles of your Dataverse instance via Api.
+- Dataverse metadata model for easy manipulation and data conversion from and to other formats (e. g. Dataverse Api metadata JSON).
+- Utils to support core functionalities.
+- Custom exceptions.
 - Tests on `Travis CI <https://travis-ci.com/AUSSDA/pyDataverse>`_ (`pytest <https://docs.pytest.org/en/latest/>`_ + `tox <http://tox.readthedocs.io/>`_).
 - Open Source (`MIT <https://opensource.org/licenses/MIT>`_)