geonamescache 3.0.1

Geonames data for continents, cities and US states.

GeonamesCache

A Python library that provides functions to retrieve names, ISO and FIPS codes of continents, countries as well as US states and counties as Python dictionaries. The country and city datasets also include population and geographic data.

Geonames data is obtained from GeoNames.

Installation

pip install geonamescache

Usage

A simple example:

import geonamescache

gc = geonamescache.GeonamesCache()
print(gc.get_countries())

Settings

Cities dataset

When creating a GeonamesCache you can set the min_city_population parameter to either of 500, 1000, 5000 or the default 15000. The smaller the minimum population the more cities are included in the cities dataset.

Methods

Currently geonamescache provides the following methods, that 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)
• get_us_counties()

In addition you can search for cities by name.

• search_cities('NAME', case_sensitive=True, contains_search=True)

This function returns a list of city records that match the given NAME.

• By default the alternatenames attribute is searched for matches.
• By default the search is case insensitive, it can be made case sensitive by changing case_sensitive to True.
• By default the search is contains, it can be made exact equality by changing contains_search to False.

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

Please write test(s) for any new feature. If you wish to build the data from scratch, run make dl and make json.