Merge pull request #11 from Ziptastic/update-for-release

Cleanup for release.

.travis.yml

@@ -7,8 +7,10 @@ python:
   - "3.5"
 
 # command to install dependencies
-install: 
+install:
   - pip install -r requirements.txt
+  - pip install requests_mock
+  - pip install coverage
   - pip install codecov
 # command to run tests
 script: nosetests --with-coverage --cover-package=ziptastic

README.rst

@@ -0,0 +1,53 @@
+Official Ziptastic Python Library
+=================================
+
+
+Python library for `GetZiptastic.com <https://www.getziptastic.com>`_
+---------------------------------------------------------------------
+
+.. image:: https://readthedocs.org/projects/ziptastic-python/badge/?version=latest
+   :target: http://ziptastic-python.readthedocs.org/en/latest/?badge=latest
+
+.. image:: https://codecov.io/gh/ziptastic/ziptastic-python/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/ziptastic/ziptastic-python/branch/master
+
+.. image:: https://travis-ci.org/Ziptastic/ziptastic-python.svg?branch=master
+   :target: https://travis-ci.org/Ziptastic/ziptastic-python
+
+.. image:: https://circleci.com/gh/Ziptastic/ziptastic-python.png
+   :target: https://circleci.com/gh/Ziptastic/ziptastic-python
+
+Installation
+------------
+
+    >>> pip install ziptastic-python
+
+
+Running tests
+-------------
+
+    $ nosetests
+
+Running tests with coverage
+---------------------------
+
+    $ nosetests --with-coverage --cover-package=ziptastic
+
+
+Usage
+=====
+
+Forward geocoding
+-----------------
+
+    >>> from ziptastic import Ziptastic
+    >>> api = Ziptastic('<your api key>')
+    >>> result = api.get_from_postal_code('48867')
+
+
+Reverse geocoding
+-----------------
+
+    >>> from ziptastic import Ziptastic
+    >>> api = Ziptastic('<your api key>')
+    >>> result = api.get_from_coordinates('42.9934', '-84.1595')

docs/index.rst

@@ -1,4 +1,4 @@
-.. ziptastic documentation master file, created by
+.. Ziptastic documentation master file, created by
    sphinx-quickstart on Sat Oct 10 22:38:11 2015.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

docs/ziptastic.rst

@@ -1,19 +1,10 @@
 Ziptastic Python package
-=================
+========================
 
-ziptastic.ziptastic module
---------------------------
+ziptastic module
+----------------
 
-.. automodule:: ziptastic.ziptastic
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: ziptastic.ziptastic
+.. automodule:: ziptastic
     :members:
     :undoc-members:
     :show-inheritance:

requirements.txt

@@ -1,18 +1 @@
-alabaster==0.7.6
-Babel==2.1.1
-coverage==4.0.1
-docutils==0.12
-funcsigs==0.4
-Jinja2==2.8
-MarkupSafe==0.23
-nose==1.3.7
-nose2==0.5.0
-pbr==1.8.1
-Pygments==2.0.2
-pytz==2015.6
 requests==2.8.0
-requests-mock==0.6.0
-six==1.10.0
-snowballstemmer==1.2.0
-Sphinx==1.3.1
-sphinx-rtd-theme==0.1.9

setup.cfg

@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal=1

setup.py

@@ -0,0 +1,45 @@
+from setuptools import setup, find_packages
+from codecs import open
+from os import path
+
+
+here = path.abspath(path.dirname(__file__))
+
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='ziptastic-python',
+    version='1.0.0b1',
+
+    description='Official GetZiptastic.com library.',
+    long_description=long_description,
+    url='https://github.com/ziptastic/ziptastic-python',
+
+    author='Thomas Schultz',
+    author_email='tom@getziptastic.com',
+    license='MIT',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Scientific/Engineering :: GIS',
+        'Topic :: Software Development :: Libraries',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+    ],
+
+    keywords='ziptastic getziptastic geocoding forward reverse geocode GIS',
+    packages=find_packages(exclude=['docs', 'tests']),
+    install_requires=['requests'],
+    extras_require={
+        'dev': ['check-manifest'],
+        'test': ['coverage', 'requests-mock'],
+    },
+)

ziptastic/tests.py → tests/tests.py

@@ -3,7 +3,9 @@
 from nose.tools import eq_
 from json import loads
 
-from .ziptastic import Ziptastic, ZiptasticAPIKeyRequiredException
+from ziptastic import Ziptastic
+from ziptastic import ZiptasticAPIKeyRequiredException
+
 
 compare_v3_json = """[{"city": "Owosso", "geohash": "dpshsfsytw8k",
     "country": "US", "county": "Shiawassee", "state": "Michigan",