Metadata-Version: 2.1
Name: django-countries-states-cities
Version: 0.1.1
Summary: Countries States Cities models for Django
Home-page: https://github.com/runners-2022/django-countries-states-cities
Author: Sunwook Kim
Author-email: sun@runners.im
License: MIT
Keywords: django cities countries regions postal codes geonames
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

.. role:: python(code)
   :language: python

########################################
django-countries-states-cities
########################################

*****
Usage
*****

0. Installation
===============

The preferred installation method is directly from pypi:

.. code:: console

   pip install -U django-countries-states-cities

.. _readme-quickstart:

1. Quickstart
=============

1. In ``settings.py``:

.. code:: python

    INSTALLED_APPS = [
        'modeltranslation',
        'django.contrib.admin',
        ...
        'countries_states_cities'
    ]

    def gettext_noop(s):
        return s

    LANGUAGES = [  # supported languages
        ("en", gettext_noop("English")),
        ("ja", gettext_noop("Japanese")),
        ("ko", gettext_noop("Korean")),
    ]

2. In ``urls.py``:

.. code:: python

    urlpatterns = [
        ...
        path('csc/', include('countries_states_cities.urls')),
    ]

3. Run ``python manage.py migrate`` to create the countries_states_cities models.

2. Configuration
================

Todo...

