Metadata-Version: 1.1
Name: geonamescache
Version: 0.16
Summary: Geonames data for continents, cities and US states.
Home-page: https://github.com/yaph/geonamescache
Author: Ramiro Gómez
Author-email: code@ramiro.org
License: Copyright (C) 2014 by Ramiro Gómez (http://ramiro.org/)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description: Geonames Cache
        ==============
        
        .. image:: https://badge.fury.io/py/geonamescache.png
                :target: http://badge.fury.io/py/geonamescache
        .. image:: https://travis-ci.org/yaph/geonamescache.png?branch=master
                :target: https://travis-ci.org/yaph/geonamescache
        
        A Python library that provides functions to retrieve names and codes of
        continents, countries and US states as Python dictionaries.
        
        Geonames data is obtained from `GeoNames
        <http://www.geonames.org/>`_.
        
        
        Installation
        ------------
        
        To install geonamescache, run: ::
        
            $ sudo pip install geonamescache
        
        Or, if necessary: ::
        
            $ sudo easy_install geonamescache
        
        
        Usage
        -----
        
        A simple usage example: ::
        
            import geonamescache
        
            gc = geonamescache.GeonamesCache()
            countries = gc.get_countries()
            # print countries dictionary
            print(countries)
            # you really wanna do something more useful with the data...
        
        
        Methods
        -------
        
        Currently geonamescache provides the following methods, that all return
        dictionaries with the requested data:
        
        - get_continents()
        - get_countries()
        - get_us_states()
        - get_cities()
        - get_countries_by_names()
        - get_us_states_by_names()
        - get_cities_by_name(name)
        
        
        Mappers
        -------
        
        The mappers module provides function(s) to map data properties. Currently you can create a mapper that maps country properties, e. g. the ``name`` property to the ``iso3`` property, to do so you'd write the following code:
        
            from geonamescache.mappers import country
            mapper = country(from_key='name', to_key='iso3')
        
            iso3 = mapper('Spain') # iso3 is assigned ESP
        
        
        Contributing
        ------------
        
        1. Fork `the repository`_ on GitHub
        2. Commit your changes to the **develop** branch
        3. Write test(s) for any new feature
        4. Push your changes and send a pull request
        
        .. _`the repository`: http://github.com/yaph/geonamescache
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
