Metadata-Version: 2.0
Name: postalcodes-mexico
Version: 0.3.1
Summary: Determines large parts of a Mexican postal address from its postal code (C.P.).
Home-page: https://github.com/flowfx/postalcodes_mexico
Author: Florian Posdziech
Author-email: hallo@flowfx.de
License: MIT license
Keywords: postalcodes_mexico
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: Click (>=6.0)

==================
Postalcodes Mexico
==================


.. image:: https://img.shields.io/pypi/v/postalcodes_mexico.svg
        :target: https://pypi.python.org/pypi/postalcodes_mexico

.. image:: https://img.shields.io/travis/FlowFX/postalcodes_mexico.svg
        :target: https://travis-ci.org/flowfx/postalcodes_mexico

.. image:: https://readthedocs.org/projects/postalcodes-mexico/badge/?version=latest
        :target: https://postalcodes-mexico.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/FlowFX/postalcodes_mexico/shield.svg
     :target: https://pyup.io/repos/github/FlowFX/postalcodes_mexico/
     :alt: Updates




Determines large parts of a Mexican postal address from its postal code (C.P.).


* Free software: MIT license
* Documentation: https://postalcodes-mexico.readthedocs.io.


Features
--------

Postalcods mexico provides a function `places` that returns a list of named tuples with all places in Mexico that share the given postal code.

Reference
---------
The data used in this package comes from the official website of the `Mexican Postal Service`_ (Correos Mexico). On the download page of the `catalogue of postal codes`_ it is stated that this data is not to be commercialized:

    El Catálogo Nacional de Códigos Postales, es elaborado por el Servicio Postal Mexicano y se proporciona en forma gratuita, no estando permitida su comercialización, total o parcial.

http://www.correosdemexico.gob.mx/lservicios/servicios/CodigoPostal_Exportar.aspx

.. _Mexican Postal Service: http://www.correosdemexico.com.mx/Paginas/Inicio.aspx
.. _catalogue of postal codes: http://www.correosdemexico.gob.mx/lservicios/servicios/CodigoPostal_Exportar.aspx

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.3.0 (2018-03-16)
------------------

* Add command line interface

0.2.1 (2018-03-16)
------------------

* Re-package everything following the 2Scoops course `Creating and Distributing Python Packages`_.

.. _Creating and Distributing Python Packages: https://courses.twoscoopspress.com/courses/take/creating-and-distributing-python-packages/

0.2.0 (2017-04-15)
------------------
* 4-digit codes return places if exist.

0.1.5 (2017-04-06)
------------------
* First release on PyPI.



