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)
- Go to https://github.com/wq/wq-docker-template
- Select "Use this template" -> "Create a new repository"
- Open the dev container via GitHub Codespaces or Docker Desktop
Docker Base Image
docker run ghcr.io/wq/base:main
Python
python3 -m venv venv
. venv/bin/activate
python -m pip install wq
wq create myproject
Node
npm init @wq myproject
CDN
<script type="module">
import wq from 'https://unpkg.com/wq';
wq.init({});
</script>
Features
wq is made up of the following submodules, which are maintained as separate packages.
Module | Github | PyPI | npm | Description |
---|---|---|---|---|
wq/wq | wq | wq | Top level package (specifies submodules as dependencies) | |
wq/wq.app | wq.app | @wq/app | A JavaScript+Python library for building robust offline-capable HTML5 data entry apps. | |
wq/wq.build | wq.build | wq command line interface. | ||
wq/wq.create | wq.create | Project template and scaffolding tools. | ||
wq/wq.db | wq.db | Django REST framework extension with design patterns for CRUD APIs. |
Project details
Release history Release notifications | RSS feed
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)
Built Distribution
wq-2.1.0-py3-none-any.whl
(3.4 kB
view hashes)