Clean up code and improve readme

Author: rliebz

dataverse/connection.py

@@ -8,11 +8,9 @@
 
 class Connection(object):
 
-    def __init__(self, host, token=None, username=None, password=None):
+    def __init__(self, host, token):
         # Connection Properties
         self.token = token
-        self.username = username
-        self.password = password
         self.host = host
         self.sd_uri = "https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document".format(host=self.host)
         self.service_document = None
@@ -22,11 +20,7 @@ def __init__(self, host, token=None, username=None, password=None):
 
     @property
     def auth(self):
-        return (self.token, None) if self.token else (self.username, self.password)
-
-    @property
-    def has_api_key(self):
-        return True if self.token else False
+        return self.token, None
 
     def connect(self):
         resp = requests.get(self.sd_uri, auth=self.auth)

dataverse/dataset.py

@@ -6,7 +6,7 @@
 import requests
 
 from exceptions import (
-    MethodNotAllowedError, NoContainerError, OperationFailedError,
+    NoContainerError, OperationFailedError,
     ConnectionError, MetadataNotFoundError, VersionJsonNotFoundError
 )
 from file import DataverseFile

dataverse/file.py

@@ -2,7 +2,7 @@
 
 
 class DataverseFile(object):
-    def __init__(self, dataset, name, file_id=None, edit_media_uri=None):
+    def __init__(self, dataset, name, file_id=None):
         self.dataset = dataset
         self.name = sanitize(name)
         self.id = file_id

dataverse/settings/defaults.py

@@ -1,5 +1,5 @@
-DEFAULT_HOST = "dataverse-demo.iq.harvard.edu"
-DEFAULT_TOKEN = "changeme"
+TEST_HOST = "dataverse-demo.iq.harvard.edu"
+TEST_TOKEN = "changeme"
 
 EXAMPLE_DICT = {
     "title": "ExampleTitle",

dataverse/test/test_dataverse.py

@@ -7,7 +7,7 @@
 from dataverse.connection import Connection
 from dataverse.dataset import Dataset
 from dataverse.exceptions import DataverseError
-from dataverse.settings import DEFAULT_TOKEN, DEFAULT_HOST
+from dataverse.settings import TEST_HOST, TEST_TOKEN
 from dataverse.test.config import PICS_OF_CATS_DATASET, ATOM_DATASET
 from dataverse import utils
 
@@ -93,7 +93,7 @@ class TestDatasetOperations(unittest.TestCase):
     @classmethod
     def setUpClass(self):
         print "Connecting to DVN."
-        self.dvc = Connection(DEFAULT_HOST, DEFAULT_TOKEN)
+        self.dvc = Connection(TEST_HOST, TEST_TOKEN)
 
         print "Getting Dataverse"
         dataverses = self.dvc.get_dataverses()

readme.md

@@ -1,37 +1,54 @@
 ## Dataverse API Client
 
 This is a library for writing Python applications that make use of Dataverse
-APIs v4.0.  The code started as a "proof of concept" in the
-[dvn/swordpoc](https://github.com/dvn/swordpoc) repo and the intent is to
-publish the python client on https://pypi.python.org.
+APIs v4.0.  The intent is to publish the python client on https://pypi.python.org.
 
 ## Installation
 
-This client requires python 2.6+.
-It has not been tested in python 3.
+    $ pip install -e git+https://github.com/IQSS/dataverse-client-python.git#egg=dataverse
+    
+Requires Python >= 2.6.
 
-To install dataverse as a package:
 
-    $ pip install -e git+https://github.com/rliebz/dvn-client-python.git#egg=dataverse
+## Usage
 
-## Configuration
+To use the python client, you will need a dataverse account and an API token.
+```python
+from dataverse import Connection
+
+host = 'apitest.dataverse.org'                  # All clients >4.0 are supported
+token = '4d0634d3-74d5-4770-8088-1971847ac75e'  # Generated at /account/apitoken
+
+connection = Connection(host, token)
+```
+
+Dataverse Objects can be retrieved from their respective containers
+```python
+dataverse = connection.get_dataverse('ALIAS')
+dataset = dataverse.get_dataset_by_doi('DOI:10.5072/FK2/ABC123')
+files = dataset.get_files('latest')
+```
+
+## Testing
+
+### Configuration
 
 Create a file at `settings/local.py`. The file should contain the following
 information:
 
 ```python
-DEFAULT_HOST = "dataverse-demo.iq.harvard.edu"
+DEFAULT_HOST = "apitest.dataverse.org"
 DEFAULT_TOKEN = "" # Token can be generated at {host}/account/apitoken
 ```
 
 Do not commit this file.
 
-## Testing
+### Running Tests
 
 In order to run any tests, you must first create a Dataverse on the
 host you wish to test. Do not run tests on the production server.
 
-To run tests
+To run tests:
 
     $ cd dataverse/test
     $ python -m unittest test_dataverse

setup.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
-import re
-import sys
 from setuptools import setup, find_packages
 import unittest
-from setuptools.command.test import test as TestCommand
 
 
 REQUIRES = [
@@ -24,7 +21,7 @@ def read(fname):
 
 setup(
     name='dataverse',
-    version='0.1',
+    version='0.1.1',
     description='Python client for Dataverse version 3.X',
     long_description=read("readme.md"),
     author='Dataverse',