adds requirements and updates readme with installation and config info

Author: codersquid

.gitignore

@@ -1,3 +1,4 @@
 .vagrant
 .DS_Store
 *pyc
+venv

dvn_client/src/requirements.txt

@@ -0,0 +1,3 @@
+-e git+https://github.com/pjbull/python-client-sword2.git#egg=sword2
+argparse # for python 2.6
+lxml

readme.md

@@ -1,7 +1,67 @@
-This is a library for writing Python applications that make use of Dataverse Network (DVN) APIs.
+## Dataverse Network (DVN) API Client
 
-The code was originally written as a "proof of concept" at https://github.com/dvn/swordpoc/tree/master/dvn_client but the intention is to eventually publish the code on https://pypi.python.org so users can run `pip install dvn-client` to use the Python library.
+This is a library for writing Python applications that make use of Dataverse
+Network (DVN) APIs.  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.
 
-For now https://github.com/dvn/swordpoc/blob/master/dvn_client/README.md has some tips but they should be incorporated into this repo.
+The proof of concept
+[README.md](https://github.com/dvn/swordpoc/blob/master/dvn_client/README.md)
+has some tips that have not been incorporated in to this readme yet.
+
+We have been trying to target Python 2.6 because that's the version that ships
+with the latest version (6) of Red Hat Enterprise Linux (RHEL) and CentOS. For
+testing backward compatibility with Python 2.6, this repo includes a Vagrant
+environment. Please note that before you run `vagrant up` you'll need to run
+`git submodule init` and `git submodule update` once after cloning this repo.
+
+## Installation
+
+You will need:
+
+* Python 2.6+
+* [pip](http://www.pip-installer.org/en/latest/)
+* gcc compiler (For OSX you will need xcode + command line tools, or [standalone install](https://github.com/kennethreitz/osx-gcc-installer#readme))
+* Dataverse account
+
+Once you have satisfied the above requirements, try the following commands.
+
+   $ git clone https://github.com/IQSS/dvn-client-python.git
+   $ cd dvn-client-python
+   $ virtualenv venv
+   $ source venv/bin/activate
+   $ pip install -r dvn_client/src/requirements.txt
+
+You may wish to manage virtualenvs using [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) instead.
+
+## Configuration
+
+You need a config.py file to run. Copy `dvn-client-python/dvn-client/src/config.py-dist`
+to your own config.py and fill out the config elements as appropriate.
+
+```python
+
+    DEFAULT_USERNAME = ""
+    DEFAULT_PASSWORD = ""
+    DEFAULT_HOST = ""
+    DEFAULT_CERT = "../resources/dvn-build.hmdc.harvard.edu" #see below for info on the cert
+    
+```
+
+## Installation Test
+
+* Navigate to `dvn-client-python/dvn-client/src/`
+* Run the client `python dvn_client.py --config config.py --runTests tests.py`
+* To run the tests, run `python dvn_test.py` (for more options see [unittest](http://docs.python.org/2/library/unittest.html#assert-methods))
+
+## PEM Certificate (optional)
+
+If you are using a self-signed certificate, you may see an SSL error when you
+try to hit the server. In that case, follow these instructions.
+
+1. Open private/incognito window (in case you have already added a security exception) in FireFox (instructions will be slightly different for other browsers)
+2. Go to: https://{SERVER}/dvn/api/data-deposit/swordv2/service-document
+3. Add Exception > View > Details > Export
+4. Save the PEM to the “resources” folder of the dvn\_client project
+5. When calling `Dataverse.connect()` or `Dataverse()` constructor, pass a path to this file as `cert=[PATH_TO_CERTIFICATE]`
 
-We have been trying to target Python 2.6 because that's the version that ships with the latest version (6) of Red Hat Enterprise Linux (RHEL) and CentOS. For testing backward compatibility with Python 2.6, this repo includes a Vagrant environment. Please note that before you run `vagrant up` you'll need to run `git submodule init` and `git submodule update` once after cloning this repo.