Skip to content

QField plugin templater

QField License: GPL v2

QField plugin templater logo

A templater that generates a QField plugin with fancy tooling.

Quick start

Run the following command:

pipx run cookiecutter gh:gounux/qfield-plugin-templater
uvx 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:

Cookiecutter logo

Built for the QField plugins framework:

QField for QGIS logo

Inspired by the QGIS plugin templater:

QGIS plugin templater logo

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

See Geotribu's QField plugin for QChat, which is following similar workflows and tooling, also used as a parallel reference and as a way to experiment and make this templater project move forward.

How to's