Metadata-Version: 2.0
Name: rgeocoder
Version: 0.1.3
Summary: A lightweight offline reverse geocoder implemented in Rust.
Home-page: https://github.com/Phil-V/rgeocoder
Author: Phil V.
Author-email: philippe@arcadian.be
License: MIT license
Keywords: rgeocoder
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Rust

rgeocoder
=========

|badgepypi| |badgetravis|

.. |badgepypi| image:: https://img.shields.io/pypi/v/rgeocoder.svg
        :target: https://pypi.python.org/pypi/rgeocoder
        :alt: PyPI version
.. |badgetravis| image:: https://img.shields.io/travis/Phil-V/rgeocoder.svg
        :target: https://travis-ci.org/Phil-V/rgeocoder
        :alt: Build Status

A lightweight offline reverse geocoder implemented in Rust with
`pyo3 <https://github.com/PyO3/pyo3>`_ python bindings.

Based on `llambda/rust-reverse-geocoder <https://github.com/llambda/rust-reverse-geocoder>`_
and `thampiman/reverse-geocoder <https://github.com/thampiman/reverse-geocoder>`_.

Basic usage
-----------

.. code-block:: sh

    pip install rgeocoder

.. code-block:: python

    >>> from rgeocoder import ReverseGeocoder
    >>> rg = ReverseGeocoder()
    >>> r = rg.nearest(41.891929, 12.511331)  # lat, lon
    >>> print(r.name, r.cc)
    'Rome IT'
    >>> print(r.lat, r.lon)
    41.89193 12.51133

Some locations include the first-
and second-level administrative divisions:

.. code-block:: python

    >>> print(r.admin1)
    'Latium'
    >>> print(r.admin2)
    'Citta metropolitana di Roma Capitale'

See `<http://download.geonames.org/export/dump/readme.txt>`_ for more
information on the dataset.


License
-------

`MIT License`_

.. _MIT License: LICENSE

Credits
-------


This package was created with Cookiecutter_ and the `mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish`: https://github.com/mckaymatt/cookiecutter-pypackage-rust-cross-platform-publish


History
-------

0.1.3 (2018-05-31)
******************

* Source distribution and Windows binary wheels.


0.1.2 (2018-05-03)
******************

* First release to PyPI.


