django-cities-xtd

Place models and worldwide place data for Django

---

django-cities provides you with place related models (eg. Country, Region, City) and data (from GeoNames) that can be used in your django projects.

This package officially supports all currently supported versions of Python/Django:

Python	3.10	3.11	3.12	3.13	3.14
Django 5.0	:white_check_mark:	:white_check_mark:	:white_check_mark:	:x:	:x:
Django 5.1	:white_check_mark:	:white_check_mark:	:white_check_mark:	:white_check_mark:	:x:
Django 5.2	:white_check_mark:	:white_check_mark:	:white_check_mark:	:white_check_mark:	:white_check_mark:
Django 6.0	:x:	:x:	:white_check_mark:	:white_check_mark:	:white_check_mark:

Key
:white_check_mark:	Officially supported, tested, and passing
:large_blue_circle:	Tested and passing, but not officially supported
:x:	Known incompatibilities

Authored by Ben Dowling, and some great contributors.

See some of the data in action at city.io and country.io.

---

Table of Contents

• Requirements
• Installation
• Configuration
  • Migration Configuration
    • Swappable Models
    • Alternative Name Types
    • Continent Data
  • Run Migrations
  • Import Configuration
    • Download Directory
    • Download Files
    • Currency Data
    • Countries That No Longer Exist
    • Postal Code Validation
    • Custom slugify() function
    • Cities Without Regions
    • Languages/Locales To Import
    • Limit Imported Postal Codes
    • Plugins
  • Import Data
• Writing Plugins
• Development
  • Code Quality Tools
  • Pre-commit Hooks
• Examples
• Third Party Apps/Extensions
• TODO
• Notes
• Running Tests
• Release Notes