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

Uploaded Source

Built Distribution

geonamescache-1.1.0-py3-none-any.whl (830.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: geonamescache-1.1.0.tar.gz
  • Upload date:
  • Size: 791.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3

File hashes

Hashes for geonamescache-1.1.0.tar.gz
Algorithm Hash digest
SHA256 2046571acb4d2c481bd81388a9fc3085bd290633cbe619ba270629e8a4aff790
MD5 231ca5bd133ccbd72938295ad90e482e
BLAKE2b-256 84a705ca15a00da01f39b5afa3fd4e51380f115e317b7711d209438ff79e86df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: geonamescache-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 830.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.3

File hashes

Hashes for geonamescache-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b0de4cab17b7786e2c7b79152164ed4250b0a675ebfb92dd883bf463fbd1142
MD5 2f6fc89390a30bb2a7735e196e690af8
BLAKE2b-256 32c1efb823270c8526b2f4f3eb8c804c5a0a55277267ad2312f5eb47bd9cc370

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