minor update as part of release preparations

Author: skasberger

.gitignore

@@ -11,14 +11,8 @@ venv_home/
 .env/
 
 # Personal
-src/pyDataverse/docs/build
-src/pyDataverse/docs/Makefile
-notes.md
-notes_*.md
-snippets.md
-stash_*.*
-src/dev/
-src/testing.py
+notes*.md
+stash*.*
 
 # Distribution / packaging
 build/
@@ -30,10 +24,12 @@ MANIFEST
 
 # Documentation
 docs/build/
+src/pyDataverse/docs/build
+src/pyDataverse/docs/Makefile
 
 # Unit test / coverage reports
 .tox
-htmlcov/
+docs/coverage_html/
 .coverage
 .coverage.*
 .*cache

.travis.yml

@@ -48,5 +48,4 @@ notifications:
   email:
     recipients:
       - stefan.kasberger@univie.ac.at
-    on_success: never
-    on_failure: always
+    on_success: change

setup.py

@@ -1,3 +1,6 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Find out more at https://github.com/AUSSDA/pyDataverse."""
 import codecs
 import os
 import re

src/pyDataverse/__init__.py

@@ -1,9 +1,10 @@
 # !/usr/bin/env python
 # -*- coding: utf-8 -*-
+"""Find out more at https://github.com/AUSSDA/pyDataverse."""
 from __future__ import absolute_import
 
 from requests.packages import urllib3
-urllib3.disable_warnings() # noqa
+urllib3.disable_warnings()  # noqa
 
 """pyDataverse
 Copyright 2019 Stefan Kasberger
@@ -17,5 +18,5 @@
 __license__ = 'MIT License'
 __version__ = '0.1.0'
 __url__ = 'https://github.com/AUSSDA/pyDataverse'
-__download_url__ = 'https://pypi.python.org/pypi/python-twitter'
+__download_url__ = 'https://pypi.python.org/pypi/pyDataverse'
 __description__ = 'A Python wrapper around the Dataverse API'

src/pyDataverse/api.py

@@ -1,4 +1,6 @@
-# coding: utf-8
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Find out more at https://github.com/AUSSDA/pyDataverse."""
 from __future__ import absolute_import
 from datetime import datetime
 import json
@@ -165,20 +167,18 @@ def make_get_request(self, query_str, params=None, auth=False):
             )
 
     def make_post_request(self, query_str, metadata=None, auth=False,
-                          headers=None, params=None):
+                          params=None):
         """Make a POST request.
 
         Parameters
         ----------
         query_str : string
             Query string for the request. Will be concatenated to
             `native_api_base_url`.
-        data : type
-            Description of parameter `data`.
+        metadata : string
+            Metadata as a json-formatted string. Defaults to `None`.
         auth : bool
             Should an api token be sent in the request. Defaults to `False`.
-        headers : dict
-            Data for the request header.
         params : dict
             Dictionary of parameters to be passed with the request.
             Defaults to `None`.
@@ -189,8 +189,6 @@ def make_post_request(self, query_str, metadata=None, auth=False,
             Response object of requests library.
 
         """
-        # TODO: update to docstring the data data-type and description.
-        # TODO: update to docstring the headers data-type and description.
         url = '{0}{1}'.format(self.native_api_base_url, query_str)
         if auth:
             if self.api_token:
@@ -207,7 +205,6 @@ def make_post_request(self, query_str, metadata=None, auth=False,
             resp = post(
                 url,
                 data=metadata,
-                headers=headers,
                 params=params
             )
             if resp.status_code == 401:
@@ -535,7 +532,7 @@ def create_dataset(self, dataverse, metadata, auth=True):
         dataverse : string
             Alias of dataverse to which the dataset should be added to.
         metadata : string
-            Dataverse metadata as json-formatted string.
+            Metadata of the Dataset as a json-formatted string.
 
         Returns
         -------

src/pyDataverse/exceptions.py

@@ -1,3 +1,6 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Find out more at https://github.com/AUSSDA/pyDataverse."""
 from __future__ import absolute_import
 
 
@@ -38,7 +41,7 @@ class ApiAuthorizationError(OperationFailedError):
 
 
 class DataverseNotEmptyError(OperationFailedError):
-    """Raised when a Dataverse cannot be found."""
+    """Raised when a Dataverse has accessioned Datasets."""
 
     pass
 
@@ -56,6 +59,6 @@ class DatasetNotFoundError(OperationFailedError):
 
 
 class DatafileNotFoundError(OperationFailedError):
-    """Raised when a Dataset cannot be found."""
+    """Raised when a Datafile cannot be found."""
 
     pass

src/pyDataverse/utils.py

@@ -1,7 +1,7 @@
-# coding: utf-8
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Find out more at https://github.com/AUSSDA/pyDataverse."""
 from __future__ import absolute_import
-
-import csv
 import json
 
 
@@ -14,12 +14,12 @@ def json_to_dict(data):
     Parameters
     ----------
     data : string
-        `data` as JSON-formatted string.
+        Data as a json-formatted string.
 
     Returns
     -------
     dict
-        `data` represented as dict().
+        Data as Python Dictionary.
 
     """
     try:
@@ -37,12 +37,12 @@ def dict_to_json(data):
     Parameters
     ----------
     data : dict
-        `data` represented as dict().
+        Data as Python Dictionary.
 
     Returns
     -------
     string
-        `data` as JSON-formatted string
+        Data as a json-formatted string.
 
     """
     try:
@@ -52,20 +52,20 @@ def dict_to_json(data):
 
 
 def read_file(filename, mode='r'):
-    """Read in data from a file.
+    """Read in a file.
 
     Parameters
     ----------
-    filename : type
-        Description of parameter `filename`.
+    filename : string
+        Filename with full path.
     mode : string
-        Read mode of file. Default is `r`. See more at
+        Read mode of file. Defaults to `r`. See more at
         https://docs.python.org/3.5/library/functions.html#open
 
     Returns
     -------
     string
-        Returns the whole content as string.
+        Returns data as string.
 
     """
     try:
@@ -78,44 +78,44 @@ def read_file(filename, mode='r'):
         raise e
 
 
-def write_file(filename, string, mode='w'):
+def write_file(filename, data, mode='w'):
     """Write data in a file.
 
     Parameters
     ----------
     filename : string
-        Full filename with path of file.
-    string : string
-        String of data to be written.
+        Filename with full path.
+    data : string
+        Data to be stored.
     mode : string
-        Read mode of file. Default is `w`. See more at
+        Read mode of file. Defaults to `w`. See more at
         https://docs.python.org/3.5/library/functions.html#open
 
     """
     try:
         with open(filename, mode) as f:
-            f.write(string)
+            f.write(data)
     except IOError:
         print('An error occured trying to write the file {}.'.format(filename))
     except Exception as e:
         raise e
 
 
 def read_file_json(filename):
-    """Read in JSON file.
+    """Read in a json file.
 
     See more about the json module at
     https://docs.python.org/3.5/library/json.html
 
     Parameters
     ----------
     filename : string
-        Full filename with path of file.
+        Filename with full path.
 
     Returns
     -------
     dict
-        Data represented as a dict().
+        Data as a json-formatted string.
 
     """
     try:
@@ -125,42 +125,17 @@ def read_file_json(filename):
 
 
 def write_file_json(filename, data, mode='w'):
-    """Write dict() in a JSON file.
+    """Write data to a json file.
 
     Parameters
     ----------
     filename : string
-        Full filename with path of file.
+        Filename with full path.
     data : dict
-        Data to be written in the JSON file.
+        Data to be written in the json file.
     mode : string
-        Write mode of file. Default is `w`. See more at
+        Write mode of file. Defaults to `w`. See more at
         https://docs.python.org/3/library/functions.html#open
 
     """
     write_file(filename, dict_to_json(data), mode)
-
-
-def read_file_csv(filename):
-    """Read in CSV file.
-
-    See more about csv.reader() at https://docs.python.org/3.5/library/csv.html
-
-    Parameters
-    ----------
-    filename : string
-        Full filename with path of file.
-
-    Returns
-    -------
-    reader
-        Reader object, which can be iterated over.
-
-    """
-    try:
-        with open(filename, newline='') as csvfile:
-            return csv.reader(csvfile, delimiter=',', quotechar='"')
-    except Exception as e:
-        raise e
-    finally:
-        csvfile.close()

tests/test_api.py

@@ -23,7 +23,7 @@
 if 'BASE_URL' in os.environ:
     BASE_URL = os.environ['BASE_URL']
 else:
-    print('ERROR: Environment variable BASE_URL for test missing.')
+        print('ERROR: Environment variable BASE_URL for test missing.')
 
 
 class TestApiConnect(object):

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36,coverage,packaging,docs,flake8
+envlist = flake8,coverage,packaging,docs,py36
 skip_missing_interpreters = True
 ignore_basepython_conflict = True