Django design patterns and REST API for citizen science field data collection.


Keywords
citizen-science, data-collection, django, django-rest-framework, rest-api, wq-framework
License
MIT
Install
pip install wq.db==1.2.0

Documentation

wq.db

wq.db is a collection of Python modules for building robust, flexible schemas and REST APIs for use in creating field data collection apps and (more generally) mobile-first websites with progressive enhancement. 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.

Latest PyPI Release Release Notes Documentation License GitHub Stars GitHub Forks GitHub Issues

Travis Build Status Python Support Django Support

Support Matrix

wq.db is compatible with Python >= 3.4 and Django >= 1.11.

  Python Django Django REST Framework
wq.db 1.0 2.7, 3.4 – 3.6 1.8, 1.10, 1.11 3.6
wq.db 1.1 2.7*, 3.4 – 3.7 1.11, 2.0, 2.1 3.9
wq.db 1.2 3.4 – 3.8 1.11, 2.x, 3.0 3.9, 3.10, 3.11
wq.db 2.0 (Future) 3.5+ 2.2+ 3.11+

* Python 2.7 support is no longer tested, but is known to work in wq.db 1.1 and earlier.

Getting Started

# Recommended: create virtual environment
# python3 -m venv venv
# . venv/bin/activate

# Install entire wq suite (recommended)
python3 -m pip install wq

# Install only wq.db
python3 -m pip install wq.db

See the documentation for more information.

Features

wq.db.rest

Extends Django REST Framework with model-based views and serializers that facilitate creating an integrated website, REST API, and mobile app. The core of the library is an admin-like ModelRouter that connects REST urls to registered models, and provides a descriptive configuration object for consumption by @wq/app. wq.db.rest also includes a GeoJSON serializer/renderer.

wq.db.patterns

A collection of abstract models and serializers for use in constructing advanced design patterns including nested forms, EAV structures, and natural keys. Includes wq.db.patterns.identify, an installable Django app module to help manage third-party entity identifers.