Getting Started

Getting Started

This guide walks through installing DQ QuestionBank Core and running your first validate-convert workflow.

Prerequisites

• Python 3.10, 3.11, or 3.12
• pip (bundled with Python)

Install

git clone https://github.com/wzsisshadiao-crypto/dq-questionbank-core
cd dq-questionbank-core
python -m venv .venv
.venv\Scripts\activate      # Windows
# source .venv/bin/activate  # macOS / Linux
pip install -e ".[docx]"

Validate the sample

dq validate examples/sample_questions.json

Expected output:

Valid: 2 question(s), schema 1.0.

Convert formats

# JSON to Markdown
dq convert examples/sample_questions.json --output-format markdown -o questions.md

# JSON to LaTeX
dq convert examples/sample_questions.json --output-format latex -o questions.tex

# Markdown back to JSON
dq import questions.md -o roundtrip.json

Launch the playground

dq serve

Open http://127.0.0.1:8765 in your browser. The playground lets you inspect, edit, validate, and download canonical question JSON. Nothing leaves your browser.

Next steps

• Read Schema Reference for the data model
• Read Format Guide for format-specific import/export details
• Read CLI Commands for every command and flag