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.3.tar.gz (751.8 kB view details)

Uploaded Source

Built Distribution

geonamescache-1.0.3-py3-none-any.whl (786.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for geonamescache-1.0.3.tar.gz
Algorithm Hash digest
SHA256 c12e419515bdb1aa689b7706a16ad65c4c1344289a94bf8d23522b62b1c90ccc
MD5 fb650d0473f24aee5e2b939e6e7b6146
BLAKE2b-256 a2b11e7c7cb5d2f04e1666663a9d018a06266d18a8c22d1afc44cb61a332723c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for geonamescache-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 664a4f111707a688c142b6bd242a91d309b5828b682247ac866862e57fec6e5c
MD5 356833c50686f5e5e93b922cdba2d923
BLAKE2b-256 53f72df10269978f37e378704d1b4bc7d62c6d0210f3c9e31c9dcf9b08a5af9c

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