readme example grid inventory

README.md

@@ -1,14 +0,0 @@
-## Python Data Access Framework for AWIPS II EDEX
-
-### Install Requirements
-
-* easy_install argparse
-* easy_install shapely
-* yum install geos geos-devel (or "brew install goes" for OS X)
-
-### Install
-
-* git clone https://github.com/Unidata/python-awips.git
-* cd python-awips
-* python setup.py install
-

README.rst

@@ -0,0 +1,65 @@
+Python Data Access Framework for AWIPS II
+=========================================
+
+.. image:: https://img.shields.io/pypi/v/python-awips.svg
+       :target: https://pypi.python.org/pypi/python-awips/
+    :alt: PyPI Package
+
+.. image:: https://img.shields.io/pypi/dm/python-awips.svg
+       :target: https://pypi.python.org/pypi/python-awips/
+    :alt: PyPI Downloads
+
+Install
+-------
+
+        pip install python-awips
+
+Prerequisites
+-------------
+
+        yum install geos geos-devel
+        pip install numpy shapely
+
+
+From Github
+-----------
+
+        git clone https://github.com/Unidata/python-awips.git
+        cd python-awips
+        python setup.py install
+
+
+Install for AWIPS II Python
+--------------------
+
+	wget https://bootstrap.pypa.io/ez_setup.py -O - | /awips2/python/bin/python
+	easy_install pip
+	/awips2/python/bin/pip install python-awips
+
+Grid Inventory
+--------------
+
+        #!python
+        from awips.dataaccess import DataAccessLayer
+
+        # Set host
+        DataAccessLayer.changeEDEXHost("edex-cloud.unidata.ucar.edu")
+
+        # Init data request
+        request = DataAccessLayer.newDataRequest()
+
+        # Set datatype 
+        request.setDatatype("grid")
+
+        #
+        # getAvailableLocationNames method will return a list of all available models
+        #
+        # LocationNames mean different things to different plugins beware...radar is icao,
+        # satellite is sector, etc
+        # 
+        available_grids = DataAccessLayer.getAvailableLocationNames(request)
+        for grid in available_grids:
+            print grid
+
+        
+

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description-file = README.rst

setup.py

@@ -3,13 +3,14 @@ from setuptools import find_packages
 
 setup(
     name='python-awips',
-    version='0.9.1',
+    version='0.9.3',
     description='A framework for requesting AWIPS meteorological datasets from an EDEX server',
     packages=find_packages(exclude='data'),
     license='Apache 2.0 / Various + US Export Controlled Technical Data',
     url='http://www.unidata.ucar.edu/software/awips2',
     download_url='https://github.com/Unidata/python-awips/tarball/0.9.1',
-    author='Unidata'
-    #requires=['argparse','shapely','numpy']
+    author='Unidata',
+    author_email='mjames@ucar.edu',
+    requires=['argparse','shapely','numpy']
 )