Skip to main content

A modular framework for mobile surveys and field data collection via offline-capable mobile web apps.

Project description


wq is a modular framework for field data collection and surveys via offline-capable mobile web apps.

Getting Started

wq can be installed via GitHub, Docker, PyPI, NPM, or a <script> tag via CDN. See the documentation for more information on getting started.

Dev Container (recommended)

  1. Go to
  2. Select "Use this template" -> "Create a new repository"
  3. Open the dev container via GitHub Codespaces or Docker Desktop

Docker Base Image

docker run


python3 -m venv venv
. venv/bin/activate
python -m pip install wq
wq create myproject


npm init @wq myproject


<script type="module">
    import wq from '';


wq is made up of the following submodules, which are maintained as separate packages.

Module Github PyPI npm Description
wq wq/wq wq wq Top level package (specifies submodules as dependencies) wq/ @wq/app A JavaScript+Python library for building robust offline-capable HTML5 data entry apps. wq/ wq command line interface.
wq.create wq/wq.create wq.create Project template and scaffolding tools.
wq.db wq/wq.db wq.db Django REST framework extension with design patterns for CRUD APIs.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wq-2.1.0.tar.gz (43.3 kB view hashes)

Uploaded Source

Built Distribution

wq-2.1.0-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page