Home > wq.create

wq.create

wq.create (formerly wq.start) provides a simple command-line interface (wq create) for starting a new project with the wq framework, with wq.app for the front end and wq.db as the backend. wq.create also provides a wq addform command that can generate and configure new Django apps from an XLSForm definition.

wq.create on GitHub

Installation

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

wq create <projectname> [directory]
cd <projectname>/db
wq addform ~/my-odk-form.xlsx

See the Getting Started docs for more information.

API

  • wq create <projectname> [directory]: Create a new Django project from the wq Django template and (optionally) the @wq Create React App template
  • wq addform ~/my-odk-form.xlsx: Create a new Django app from the provided XLSForm (uses xlsform-converter)
  • wq addform
  • wq create