Django Country Kit

Django Country Kit is a Django app that provides country-related functionality, including a custom model field for storing country codes, a form widget for selecting countries, and associated tests.

Features

• Country Model Field: Easily store and retrieve country codes in your Django models.
• Country Widget: A form widget for rendering a dropdown list of countries in your Django forms.

Installation

1. Install Django Country Kit using pip:

   pip install django-country-kit
   

2. Add 'django_country_kit' to your INSTALLED_APPS in your Django project's settings:

   INSTALLED_APPS = [
       # ...
       'django_country_kit',
       # ...
   ]
   

3. Run collectstatic:

   python manage.py collectstatic
   

Usage

Country Model Field

In your models, use the CountryField to store country codes:

from django.db import models
from django_country_kit.fields import CountryField

class YourModel(models.Model):
    country = CountryField()

For multiple selections:

from django.db import models
from django_country_kit.fields import CountryField

class YourModel(models.Model):
    countries = CountryField(multiple=True)

To exclude or restrict the available countries on a single field (without changing project-wide settings):

from django.db import models
from django_country_kit.fields import CountryField

class YourModel(models.Model):
    # Drop a few countries from the dropdown
    country = CountryField(exclude=["US", "CA"])

    # Or restrict the dropdown to an allow-list
    shipping_country = CountryField(include=["NL", "DE", "FR"])

exclude and include can be combined; exclude always wins.

Country Widget

In your forms, use the CountryWidget to render a dropdown list of countries:

from django import forms
from django_country_kit.widgets import CountryWidget

class YourForm(forms.Form):
    country = forms.CharField(widget=CountryWidget())

For multiple selections:

from django import forms
from django_country_kit.widgets import MultipleCountryWidget

class YourForm(forms.Form):
    countries = forms.CharField(widget=MultipleCountryWidget())

Both widgets accept exclude and include kwargs for per-widget filtering:

from django import forms
from django_country_kit.widgets import CountryWidget

class YourForm(forms.Form):
    country = forms.CharField(widget=CountryWidget(exclude=["US", "CA"]))

Country Class

The Country class represents a country and provides properties for accessing its name and alpha3 code. This class is part of the Django Country Kit and offers convenient functionality for handling country-related data.

Usage

You can create an instance of the Country class to retrieve information about a specific country. Here's how you can use it:

from django_country_kit.base import Country

# Create a Country instance with a specific country code
country = Country(code='US')

# Retrieve the name of the country
country_name = country.name  # Returns 'United States'

# Retrieve the alpha3 code of the country
country_alpha3 = country.alpha3  # Returns 'USA'

Custom settings

Django Country Kit provides custom settings for further customization of country data:

• OVERRIDE_COUNTRIES: Allows users to override specific countries with custom data.
• EXCLUDE_COUNTRIES: Allows users to exclude specific countries from the available choices.
• INCLUDE_COUNTRIES: Allows users to include specific countries in the available choices.

You can customize these settings in your Django project's settings file to tailor the country data according to your needs.

For per-field overrides (rather than project-wide), pass exclude= or include= directly to CountryField, CountryWidget, or MultipleCountryWidget — see the usage examples above.

We appreciate your feedback and contributions to improving Django Country Kit!

Development

If you want to contribute to Django Country Kit, follow these steps to set up your development environment:

1. Install pipenv if you haven't already:

   pip install pipenv
   

2. Clone the repository:

   git clone https://github.com/your_username/django-country-kit.git
   

3. Navigate to the project directory:

   cd django-country-kit
   

4. Install development dependencies:,

   pipenv install --dev
   

5. Activate the virtual environment:

   pipenv shell
   

6. Run migrations:

   python manage.py migrate
   

7. Run collectstatic:

   python manage.py collectstatic
   

8. Start the development server:

   python manage.py runserver