QField plugin templater

A templater that generates a QField plugin with fancy tooling.

Quick start

Run the following command:

• with pip:

pipx run cookiecutter gh:gounux/qfield-plugin-templater

Or install cookiecutter and run:

pipx install cookiecutter
cookiecutter gh:gounux/qfield-plugin-templater

• with uv:

uvx cookiecutter gh:gounux/qfield-plugin-templater

Or install cookiecutter and run:

uv tool install cookiecutter
cookiecutter gh:gounux/qfield-plugin-templater

After a few prompts, there you go: you have a new QField plugin with a ready-to-go dev workflow and fancy tooling!

References

Based on the cookiecutter templating engine:

Built for the QField plugins framework:

Inspired by the QGIS plugin templater:

Featuring icons from the Lucide icon set, and sounds from pixabay - see terms of license.

Contributing

See Contribution guidelines for details on how to contribute to this project.

TL;DR:

• See the Contributor Covenant Code of Conduct v2.
• After cloning the repository, install the pre-commit hooks via pre-commit install.
• Install uv then dependencies via uv sync.
• Serve the doc locally via uv run zensical serve -f documentation/zensical.toml.
• Resize the documentation images to webp format via ./scripts/resize-image.sh documentation/docs/images/the_image.png 800.