Skip to main content

A django model & fixture containing all data from the countries table of Geonames.org

Project description

https://badge.fury.io/py/django-countries-plus.svg https://travis-ci.org/cordery/django-countries-plus.svg?branch=master https://codecov.io/gh/cordery/django-countries-plus/branch/master/graph/badge.svg

The Country Model

The model provides the following fields (original geonames.org column name in parentheses).

  • iso (ISO)
  • iso3 (ISO3)
  • iso_numeric (ISO-Numeric)
  • fips (fips)
  • name (Country)
  • capital
  • area (Area(in sq km))
  • population (population)
  • continent (continent)
  • tld (tld)
  • currency_code (CurrencyCode)
  • currency_name (CurrencyName)
  • currency_symbol (Not part of the original table)
  • phone (Phone)
  • postal_code_format (Postal Code Format)
  • postal_code_regex (Postal Code Regex)
  • languages (Languages)
  • geonameid (geonameid)
  • neighbors (neighbours)
  • equivalent_fips_code (EquivalentFipsCode)

Installation

Step 1: Install From PyPi

pip install django-countries-plus

Step 2: Add countries_plus to your INSTALLED_APPS

Step 3: Run python manage.py sync (Django <1.7) or python manage.py migrate (Django 1.7+)

Step 4: Load the Countries Data

  1. Load the countries data into your database with the update_countries_plus management command.
    python manage.py update_countries_plus
  2. (alternative) Load the provided fixture from the fixtures directory.
    python manage.py loaddata PATH_TO_COUNTRIES_PLUS/countries_plus/countries_data.json.gz

Usage

Retrieve a Country:

from countries_plus.models import Country
usa = Country.objects.get(iso3='USA')

Update the countries data with the latest geonames.org data:

python manage.py update_countries_data

This management command will download the latest geonames.org countries data and convert it into Country objects. Existing Country objects will be updated if necessary. No Country objects will be deleted, even if that country has ceased to exist.

Add the Request Country to each Request

  1. Add countries_plus.middleware.AddRequestCountryMiddleware to your MIDDLEWARE setting.

  2. add the following two settings to your settings.py:

    COUNTRIES_PLUS_COUNTRY_HEADER - A string defining the name of the meta header that provides the country code. Ex: ‘HTTP_CF_COUNTRY’ (from https://support.cloudflare.com/hc/en-us/articles/200168236-What-does-CloudFlare-IP-Geolocation-do-)

    COUNTRIES_PLUS_DEFAULT_ISO - A string containing an iso code for the country you want to use as a fallback in the case of a missing or malformed geoip header. Ex: ‘US’ or ‘DE’ or ‘BR’

    Example:

    COUNTRIES_PLUS_COUNTRY_HEADER = 'HTTP_CF_COUNTRY'
    COUNTIRES_PLUS_DEFAULT_ISO = 'US'
    

Add the Request Country to the Request Context

  1. Enable the optional middleware as described above
  2. Add countries_plus.context_processors.add_request_country to your template TEMPLATE_CONTEXT_PROCESSORS setting (Django <1.8) or to your ‘context_processors’ option in the OPTIONS of a DjangoTemplates backend instead (Django 1.8)

Compatibility

Python 2.7+ & 3.6+. Django 1.11 and Django 2.0+ supported, however should still work on Django 1.4-1.10.

Note: if you are using Django 1.7, tests will fail unless you are using Django 1.7.2 or higher due to a bug in earlier versions.

Integrating with django-languages-plus

If you also have django-languages-plus(https://pypi.python.org/pypi/django-languages-plus) installed then you can run the following command once to associate the two datasets and generate a list of culture codes (pt_BR for example):

from languages_plus.utils import associate_countries_and_languages
associate_countries_and_languages()

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

# Changelog All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.2.1] - 2017-12-13 ### Fixed - Fixtures dir is now properly included in pip package

## [1.2.0] - 2017-12-13 ### Added - Cleaned up project & improved documentation

### Changed - Added tests for Django 2.0 - Dropped tested support for Django versions < 1.11

## [1.1.0] - 2016-03-14 ### Fixed - Fixed Geonames.org file format error

## [1.0.1] - 2015-06-16 ### Added - Improved test coverage.

### Changed - The Country model has had all fields with undefined lengths (ex: name) expanded to max_length=255. Defined length fields (ex: Iso, Iso3) are unchanged. - Two countries (Dominican Republic and Puerto Rico) have two phone number prefixes instead of 1. These prefixes are now comma separated. - The Country model will now validate on save and reject values of the wrong length. The test suite has been expanded to test this.

### Fixed - Fixed update_countries_plus command for python 3

## [1.0.0] - 2015-06-11 ### Added - Added feature to update data from geonames.org. - Test coverage has been substantially improved.

### Changed - The data migration has been removed in favour of the new management command and manually loading the fixture. - The fixture is no longer named initial_data and so must be loaded manually, if desired. - In order to provide better compatibility with the way Django loads apps the Country model is no longer importable directly from countries_plus. - The get_country_by_request utility function has been moved into the Country model, and is available as Country.get_by_request(request)

### Fixed - General code cleanup & improved test coverage.

### Note - If you have been running an earlier version you should run python manage.py update_countries_plus to update your data tables as they may contain incorrect data.

## [0.3.3] - 2015-01-27 ### Changed - Now uses Django 1.7 data migration pattern

## [0.3.2] - 2015-01-10 ### Fixed - Corrected version number on setup.py

## [0.3.1] - 2015-01-09 ### Added - Now compatible with Python 3 thanks to luiscberrocal

## [0.3.0] - 2014-09-08 ### Added - Now compatible with Django 1.7 thanks to mrben

## [0.2.0] - 2014-02-13 ### Added - Added middleware that adds the request country to the request object.

## [0.1.5] - 2013-06-14 ### Fixed - Corrected model max_length attributes to properly match data.

## [0.1.0] - 2013-05-22 ### Added - Initial release.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_countries_plus-1.2.1-py2.py3-none-any.whl (39.4 kB) Copy SHA256 hash SHA256 Wheel 3.6 Dec 14, 2017
django-countries-plus-1.2.1.tar.gz (37.8 kB) Copy SHA256 hash SHA256 Source None Dec 14, 2017

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