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. |
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 details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
wq-2.1.0-py3-none-any.whl
(3.4 kB
view details)
File details
Details for the file wq-2.1.0.tar.gz.
File metadata
- Download URL: wq-2.1.0.tar.gz
- Upload date:
- Size: 43.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09231bc0d98fd7a6deb96161ca2e3fd64fcdb92fa3d7e52f8649a38d4e82a925
|
|
| MD5 |
095ea3e4390189bfd73c4f20bda8cbb0
|
|
| BLAKE2b-256 |
8d4090e45d212c7bc28186ca61aa1e6ccd99ae88f5510a5e8287f71635896546
|
File details
Details for the file wq-2.1.0-py3-none-any.whl.
File metadata
- Download URL: wq-2.1.0-py3-none-any.whl
- Upload date:
- Size: 3.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
603a825bf8da254bedd3b58690815a55d52954d1d372c11e69525993c3e95635
|
|
| MD5 |
f1ffe0db0b4e6e75dc22f10817c360b3
|
|
| BLAKE2b-256 |
b4a91742ead4b206b364bb0f191a5ad013e6f531132a4a33908cba9fc0aab44f
|
