Skip to main content

Geonames data for continents, cities and US states.

Project description

https://img.shields.io/pypi/v/geonamescache.svg https://travis-ci.org/yaph/geonamescache.png?branch=master

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

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)
  • get_us_counties()

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

If you wish to build the data from scratch, run make dl and make tojson.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for geonamescache, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size geonamescache-1.1.0-py3-none-any.whl (830.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size geonamescache-1.1.0.tar.gz (791.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page