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.

Source Distribution

geonamescache-1.0.2.tar.gz (747.9 kB view details)

Uploaded Source

Built Distribution

geonamescache-1.0.2-py3-none-any.whl (782.0 kB view details)

Uploaded Python 3

File details

Details for the file geonamescache-1.0.2.tar.gz.

File metadata

  • Download URL: geonamescache-1.0.2.tar.gz
  • Upload date:
  • Size: 747.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for geonamescache-1.0.2.tar.gz
Algorithm Hash digest
SHA256 d34c61286c6e5d9e387e1afec24164921bf197516bb99ee2ce4557adfd492263
MD5 b1b00e21d3b6bb51efb3dd2083d41b13
BLAKE2b-256 bc8dadc59b775c1c65e62e932c2caf4530c8d1eb8ec9167af1345030f5dfad2c

See more details on using hashes here.

File details

Details for the file geonamescache-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for geonamescache-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f68df47048451608994446f430adecf6df9a2018281ea859fa4fa91cf00f05c6
MD5 4505aa7d41d8fe8f9e59643ce7281b66
BLAKE2b-256 96345daf3ed920ffaf761615addbdbb6d91dc802a36c68551e7c6568fe20d7f6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page