Skip to main content

Provides a country field for Django models.

Project description

A Django application which provides country choices for use with forms, and a country field for models.

To use the flags, you will want to copy the flags directory of django_countries/media to your static files directory, or use the django-staticfiles application.

CountryField

A country field for Django models that provides all ISO 3166-1 countries as choices.

CountryField is based on Django’s CharField, providing choices corresponding to the official ISO 3166-1 list of countries (with a default max_length of 2).

Consider the following model using a CountryField:

from django.db import models
from django_countries import CountryField

class Person(models.Model):
    name = models.CharField(max_length=100)
    country = CountryField()

Any Person instance will have a country attribute that you can use to get details of the person’s country:

>>> person = Person(name='Chris', country='NZ')
>>> person.country
Country(code='NZ')
>>> person.country.name
u'New Zealand'
>>> person.country.flag
u'/static/flags/nz.gif'

This object (person.country in the example) is a Country instance, which is described below.

The Country object

An object used to represent a country, instanciated with a two character country code.

It can be compared to other objects as if it was a string containing the country code, and it’s __unicode__ method returns the country code.

name

Contains the full country name.

flag

Contains a URL to the flag. 'flags/[lowercasecountrycode].gif' is appended to the STATIC_URL setting, or if that isn’t set, the MEDIA_URL setting.

Country Choices

The django_countries.countries module contains some constants which can be used to generate choices lists for a Django Select form field.

COUNTRIES

A tuple of two part tuples, each consisting of a country code and the corresponding nicely titled (and translatable) country name.

COUNTRIES_PLUS

A tuple, similar to COUNTRIES, but also includes duplicates for countries that contain a comma (i.e. the non-comma’d version).

OFFICIAL_COUNTRIES

A dictionary where each key is a country code and each value is the corresponding official capitalised ISO 3166-1 English country name.

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

django-countries-1.0.5.tar.gz (98.3 kB view details)

Uploaded Source

File details

Details for the file django-countries-1.0.5.tar.gz.

File metadata

File hashes

Hashes for django-countries-1.0.5.tar.gz
Algorithm Hash digest
SHA256 84a58e249599daf203f2f7c7af62473d2a2e63f44babdbbf76e6d286f4fbf735
MD5 58fb3b30eb2cdb100b9fd8e2204b20ba
BLAKE2b-256 0650039932735dbdcf1f6271142df3b761cedc782f4addc484d34c76ccb8111e

See more details on using hashes here.

Provenance

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