diff --git a/.gitignore b/.gitignore index b8f039c..b6cdd18 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ env/ htmlcov/ lib/ lib64/ +MANIFEST nosetests.xml parts/ pip-delete-this-directory.txt diff --git a/README.rst b/README.rst index 9e9e494..d258033 100644 --- a/README.rst +++ b/README.rst @@ -14,6 +14,9 @@ A Python implementation of Google's Encoded Polyline Algorithm Format (http://goo.gl/PvXf8Y). This is essentially a port of https://github.com/mapbox/polyline built with Python 2 and 3 support in mind. +The documentation for ``polyline`` can be found at +http://polyline.readthedocs.org/. + License ------- diff --git a/docs/conf.py b/docs/conf.py index 31c4fd4..734e3b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,7 @@ # The short X.Y version. version = '1.0' # The full version, including alpha/beta/rc tags. -release = '1.0.0-dev' +release = '1.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index 67847aa..f1a1afd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,9 +19,11 @@ https://github.com/mapbox/polyline built with Python 2 and 3 support in mind. Installation ============ -`polyline` can be installed using `pip`: +``polyline`` can be installed using ``pip`` or ``easy_install``:: - pip install polyline + $ pip install polyline + or + $ easy_install polyline API Documentation ================= @@ -31,7 +33,7 @@ Encoding To get the encoded polyline representation of a given set of coordinates:: - from polyline.codec import PolylineCodec + from polyline import PolylineCodec PolylineCodec().encode([(38.5, -120.2), (40.7, -120.9), (43.2, -126.4)]) This should return ``_p~iF~ps|U_ulL~ugC_hgN~eq`@``. @@ -41,7 +43,7 @@ Decoding To get the set of coordinates reprented by a given encoded polyline string:: - from polyline.codec import PolylineCodec + from polyline import PolylineCodec PolylineCodec().decode('u{~vFvyys@fS]') This should return ``[(40.63179, -8.65708), (40.62855, -8.65693)]``. diff --git a/polyline/__init__.py b/polyline/__init__.py index ca5373e..a385445 100644 --- a/polyline/__init__.py +++ b/polyline/__init__.py @@ -1 +1,3 @@ -__version__ = '1.0.0-dev' +__version__ = '1.0' + +from polyline.codec import PolylineCodec # NOQA diff --git a/setup.py b/setup.py index c58c160..b48a97d 100644 --- a/setup.py +++ b/setup.py @@ -9,8 +9,6 @@ except ImportError: from distutils.core import setup -import polyline - desc = "A Python implementation of Google's Encoded Polyline Algorithm Format." with open('README.rst', 'r') as f: @@ -22,7 +20,7 @@ setup( name='polyline', - version=polyline.__version__, + version='1.0', description=desc, long_description=long_desc, author='Bruno M. Custódio', @@ -35,7 +33,7 @@ license='MIT', zip_safe=False, classifiers=( - 'Development Status :: 2 - Pre-Alpha', + 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Programming Language :: Python',