General updates figuring out how PyPI works

Author: Tom Clark

requirements.txt

@@ -1,22 +1,2 @@
-appdirs==1.4.3
-args==0.1.0
-clint==0.5.1
-packaging==16.8
-pyparsing==2.2.0
-six==1.10.0
-
-# TODO Remove this to separate oasys SDK and sdk-examples repo
---editable octue
-
-# ----------- Some common libraries you may wish to include. Removing these may break the examples, but won't break the template :) ------------
-
-# Plotting tools to help create json based figure files (more powerful and better validation than creating the raw json yourself)
-#plotly==2.0.5
-
-# A numerical manipulation library
-numpy==1.12.1
-
-# A powerful database api library. Supply it with your db's uri (through environment variables - don't commit URIs to git!!!!) and read/add data to/from databases.
-# Note that results of analyses using externally managed databases as data sources cannot be guaranteed to be idempotent.
-#SQLAlchemy==1.0.12
-#SQLAlchemy-Utils==0.31.6
+wheel
+twine

setup.py

@@ -1,14 +1,30 @@
-from setuptools import setup
+from setuptools import setup, find_packages
 
+# Note:
+#   The Hitchiker's guide to python provides an excellent, standard, method for creating python packages:
+#       http://docs.python-guide.org/en/latest/writing/structure/
+#
+#   To deploy on PYPI follow the instructions at the bottom of:
+#       https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi
+#   where the username on pypi for all octue modules is 'octue'
+
+with open('README.md') as f:
+    readme_text = f.read()
+
+with open('LICENSE') as f:
+    license_text = f.read()
 
 setup(name='octue',
-      version='0.1',
+      version='0.1.0',
       # packages=['octue', 'octue.utils', 'octue.config', 'octue.manifest', 'octue.resources'],
       url='https://www.github.com/octue/octue-sdk-python',
-      license='',
-      author='thclark',
+      license=license_text,
+      author='Thomas Clark',
       author_email='[email protected]',
-      description='A python package providing a python SDK to the Octue API and providing supporting functions to Octue applications')
+      description='A package providing a python SDK to the Octue API and supporting functions for Octue applications',
+      long_description=readme_text,
+      packages=find_packages(exclude=('tests', 'docs'))
+      )
 
 
 # TODO move the following into octue example app template