These instructions are a little shabby, I haven't had a whole lot of time to devote to explaining things thoroughly. If you're interested in using this but are having trouble getting it setup please feel free to email me at [email protected], I'll assist as best I can and update the instructions in the process. Cheers!
Also, there will be bugs, please let me know of any issues and I'll do my best to fix them.
Previously a patch for Django was required to make this app work, but as of 1.7 the patch is no longer needed. Installation is now done as per usual. The package is installed with:
python setup.py installThen, add address to your INSTALLED_APPS list in settings.py:
INSTALLED_APPS = (
...
'address',
)The rationale behind the model structure is centered on trying to make it easy to enter addresses that may be poorly defined. The model field included uses Google Maps API v3 (via the nicely done geocomplete jquery plugin) to determine a proper address where possible. However if this isn't possible the raw address is used and the user is responsible for breaking the address down into components.
It's currently assumed any address is represent-able using four components: country, state, locality and street address. In addition, country code, state code and postal code may be stored, if they exist.
There are four Django models used:
Country
name
code
State
name
code
country -> Country
Locality
name
postal_code
state -> State
Address
raw
street_number
route
locality -> Locality
To simplify storage and access of addresses, a subclass of ForeignKey named
AddressField has been created. It provides an easy method for setting new
addresses.
It can be created using the same optional arguments as a ForeignKey field. For example:
from address.models import AddressField
class MyModel(models.Model):
address1 = AddressField()
address2 = AddressField(related_name='+', blank=True, null=True)Values can be set either by assigning an Address object:
addr = Address(...)
addr.save()
obj.address = addrOr by supplying a dictionary of address components:
obj.address = {'street_number': '1', route='Somewhere Ave', ...}The structure of the address components is as follows:
{
'raw': '1 Somewhere Ave, Northcote, VIC 3070, AU',
'street_number': '1',
'route': 'Somewhere Ave',
'locality': 'Northcote',
'postal_code': '3070',
'state': 'Victoria',
'state_code': 'VIC',
'country': 'Australia',
'country_code': 'AU'
}All except the raw field can be omitted. In addition, a raw address may
be set directly:
obj.address = 'Out the back of 1 Somewhere Ave, Northcote, Australia'When accessed, the address field simply returns an Address object. This way all components may be accessed naturally through the object. For example::
route = obj.address.route
state_name = obj.address.locality.state.nameIncluded is a form field for simplifying address entry. A Google maps auto-complete is performed in the browser and passed to the view. If the lookup fails the raw entered value is used.
TODO: Talk about this more.
The model:
from address.models import AddressField
class Person(models.Model):
address = AddressField()The form:
from address.forms import AddressField
class PersonForm(forms.Form):
address = AddressField()
The template:
<head>
{{ form.media }} <!-- needed for JS/GoogleMaps lookup -->
</head>
<body>
{{ form }}
</body>