wq.db 0.3.1

Django design patterns and REST API for field data collection.

wq.db

wq.db is a collection of Python modules for building robust, flexible schemas and REST APIs for use in field data collection apps and (more generally) progressively enhanced mobile-first websites. wq.db is the backend component of wq and is geared primarily for use with wq.app, though it can be used separately. wq.db is built on the Django platform.

Getting Started

pip install wq.db
# Or, if using together with wq.app and/or wq.io
pip install wq

See the documentation for more information. See https://github.com/wq/wq.db to fork wq.db or report any issues.

Features

wq.db has two primary components: a REST API generator (wq.db.rest) and a collection of schema design patterns (wq.db.patterns) that facilitate flexible database layouts.

wq.db.rest

Extends the excellent Django Rest Framework with a collection of views, serializers, and context processors useful for creating a progresively enhanced website that serves as its own mobile app and its own REST API. The core of the library (app.py) includes an admin-style autodiscover() that automatically routes REST urls to installed models, and provides a descriptive JSON configuration object for consumption by wq.app’s client-side router. wq.db.rest also includes a CRS-aware GeoJSON serializer and renderer.

wq.db.patterns

A collection of recommended design patterns (annotate, identify, locate, and relate) that provide long-term flexibility and sustainability for data collection systems. These patterns are implemented as installable Django apps.

Batteries Included

Like Django itself, wq.db includes a contrib module that provides additional functionality not considered to be part of the “core” library.

files

Generic file manager. Supports using the same FileField for both images and files. Also includes a URL-driven thumbnail generator.

vera

Reference implementation of the ERAV model, an extention to EAV with support for maintaining multiple versions of an entity.