Merge pull request #33 from unt-libraries/prepare-first-release

Prepare first release

README.md

@@ -4,16 +4,25 @@ is being developed according to the [ait-specification](https://github.com/WASAP
 
 ## Requirements
 
-* Python 3.4, 3.5, or 3.6
+* Python 3.4-3.7
 
 ## Installation
 
-The WASAPI client may be installed with:
+To run the latest code, the WASAPI client may be downloaded or cloned
+from [GitHub](https://github.com/unt-libraries/py-wasapi-client). From inside the top-level of the py-wasapi-client directory,
+install with:
 
 ```
  $ python setup.py install
 ```
 
+Alternatively, the most recent release (not guaranteed to be the latest
+code) may be installed from [PyPi](https://pypi.org/project/py-wasapi-client/):
+
+```
+ $ pip install py-wasapi-client
+```
+
 Once installed, run the client at the command line with:
 
 ```
@@ -196,5 +205,6 @@ $ python setup.py test
 or
 
 ```
+$ pip install tox
 $ tox
 ```

setup.py

@@ -3,15 +3,22 @@
 from setuptools import setup
 
 
+with open('README.md', 'r') as readme_f:
+    long_description = readme_f.read()
+
+
 setup(
     name='py-wasapi-client',
-    version='0.1',
+    version='1.0.0',
     url='https://github.com/unt-libraries/py-wasapi-client',
     author='University of North Texas Libraries',
+    author_email='lauren.ko@unt.edu',
     license='BSD',
     py_modules=['wasapi_client'],
     scripts=['wasapi_client.py'],
     description='A client for the [Archive-It] WASAPI Data Transer API',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     install_requires=['requests>=2.18.1'],
     entry_points={
         'console_scripts': [
@@ -28,6 +35,7 @@
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Topic :: Communications :: File Sharing',
     ],
 )

tox.ini

@@ -2,13 +2,13 @@
 max-line-length = 99
 
 [tox]
-envlist = py34,py35,py36,py37,flake8
+envlist = py34,py35,py36,py37,py37-flake8
 
 [testenv]
 usedevelop=True
 deps = -r{toxinidir}/requirements-test.txt
 commands = py.test
 
-[testenv:flake8]
+[testenv:py37-flake8]
 deps = flake8
 commands = flake8 wasapi_client.py tests setup.py