README.rst

django-cep

This application enables Django powered websites to have autofilled address fields in forms based on brazilian CEP field.

Installation

To install django-cep simply run:

pip install django-cep

Configuration

We need to hook django-cep into our project.

Put cep into your INSTALLED_APPS at settings module:

INSTALLED_APPS = (
   ...
   'cep',
)

Bind the cep urls.py into your main urls.py with something like:

url(r'^cep/', include('cep.urls')),

Usage

Currently the only syntax supported is setting the IDs of the address fields in the widget of the CEP field. For other ways to set this up, see the NEXT-STEPS file.

1. Import the django-cep widget CEPInput in your forms.py:

   from cep.widgets import CEPInput
   

2. Set your CEP field for using the CEPInput, with the correct address fields ID, for example:

   my_cep_field = ChangeToMyCEPFieldModelName(label=u"CEP",
                           help_text="Format: XXXXX-XXX",
                           widget=CEPInput(address={
                                                    'street': 'id_street_field',
                                                    'district': 'id_district_field',
                                                    'city': 'id_city_field',
                                                    'state': 'id_state_field'
                                                    }))
   

That stands for a street field ID equals id_street_field, district field ID equals id_district_field, city field ID equals id_city_field and a state field ID equals id_state_field.

Also note that the JavaScript used in this app requires JQuery to run properly.

It is highly recommended that you use Django Localflavor's BRStateChoiceField for the State field, to make it render the correct brazilian state from the list.