django-tastypie-sepomex 0.1.0

Little django application that exposes the sepomex database in a RESTful way.

Little django application that exposes the sepomex database in a RESTful way.

Installation

$ pip install django-tastypie-sepomex

Configuration

1. Once installed, you must add sepomex to your INSTALLED_APPS

INSTALLED_APPS += ['sepomex']

2. Apply migrate command to add the sepomex models to your database.

$ python manage.py migrate sepomex

3. The sepomex data is provided in a file called sepomex-data.tar.gz, you need to extract the content.

$ tar xvf sepomex-data.tar.gz

4. Populate your sepomex models

$ python manage.py loadsepomex

This command will call the loadmxstates and loadmxmunicipalities commands. It finally will fill the sepomex_mxasentamiento table to complete the process.

Run your server

$ python manage.py runserver

… and use the endpoints provided

Get the list of states

There are 32 states, so we pass that as a query string.

$ curl localhost:8000/api/v1/mxestado/?limit=32

List first 20 municipalities for Coahuila

Coahuila’s id is 5. If not specified, the limit objects per query is 20

$ curl localhost:8000/api/v1/mxmunicipio/?mx_estado__id=5

Activate sepomex logger

Example of LOGGING dict in settings.py. You might have more loggers.

LOGGING = {
    'version': 1.0,
    'disable_existing_loggers': False,
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler'
        }
    },
    'loggers': {
        'sepomex': {
            'handlers': ['console'],
            'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),
        },
        # Your loggers here
    }
}