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. |
Metadata
Release files for wq 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wq-2.1.0.tar.gz | 43.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wq-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.7 kB
Release files / wq-2.1.0.tar.gz
| Download URL | wq-2.1.0.tar.gz |
|---|---|
| Size | 43.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
09231bc0d98fd7a6deb96161ca2e3fd64fcdb92fa3d7e52f8649a38d4e82a925
|
|
BLAKE2b-256 checksum How to use checksums |
8d4090e45d212c7bc28186ca61aa1e6ccd99ae88f5510a5e8287f71635896546
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / wq-2.1.0-py3-none-any.whl
| Download URL | wq-2.1.0-py3-none-any.whl |
|---|---|
| Size | 3.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
603a825bf8da254bedd3b58690815a55d52954d1d372c11e69525993c3e95635
|
|
BLAKE2b-256 checksum How to use checksums |
b4a91742ead4b206b364bb0f191a5ad013e6f531132a4a33908cba9fc0aab44f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
