FAQ

FAQ

General

What is DQ QuestionBank Core?

An open-source, database-neutral Python library for importing, validating, converting, and exchanging structured educational questions. It defines a canonical JSON schema and provides adapters for JSON, Markdown, LaTeX, and DOCX.

What license does it use?

Apache License 2.0. See the LICENSE.

Does it contain real exam questions?

No. The repository includes only synthetic, openly-licensed example questions. No production question bank, user data, or private database is included.

Usage

How do I validate my own questions?

dq validate my-questions.json

Your JSON must conform to the canonical schema. Start from examples/sample_questions.json as a template.

Can I use it with Microsoft Word?

Yes. Install the optional python-docx dependency and use:

pip install ".[docx]"
dq import my-exam.docx -o questions.json

What Python versions are supported?

3.10, 3.11, and 3.12. Python 3.9 and earlier are not supported.

Troubleshooting

ModuleNotFoundError: No module named 'docx'

Install the optional dependency: pip install "dq-questionbank-core[docx]".

SchemaNotFoundError

The JSON Schema file is missing from your installation. Reinstall from an official source.

FormatDetectionError: Cannot detect input format

Your file extension is not recognized. Use --input-format to specify manually.

Validation reports errors on my file

Run dq validate my-file.json --json for machine-readable output. Check each path, code, and message.

Contributing

Report bugs and request features on GitHub Issues.

Read CONTRIBUTING.md before submitting a pull request.

Report security vulnerabilities according to SECURITY.md. Do not place secrets or copyrighted exam banks in public issues.