NiceGUI Project Template

Prerequisites

pipx is used to install copier independent of your new project's dependencies:

1. install pipx according to the documentation here.
2. install copier with pipx: pipx install copier (tested with copier==9.7.1).

Quickstart

1. generate your project:

copier copy git@github.com:zauberzeug/nicegui-template.git path/to/project

2. explore your new project:

cd path/to/project

3. initialize a git repo:

git init

4. create a virtual environment:

virtualenv .venv # or without virtualenv:
python -m venv .venv

source .venv/bin/activate # to activate your virtual environment

5. install standard dependencies to start working:

poetry install --with dev # with poetry 
pip install -r requirements-dev.txt # without poetry

6. start your project:

./main.py

Available Questions / Options

name	type	options	default	explanation
project name	str		-	the project's name as stated in the pyproject.toml
module name	str		same as project name	the name of the main module in the root directory of the project
project description	str		-	used in the pyproject.toml
use poetry	boolean	true / false	false	use Poetry to manage the project's dependencies and virtual environment
python versions	str	3.8 to 3.13	[3.9, 3.10, 3.11, 3.12]	defines the required and supported python versions
use precommit	boolean	true / false	false	use pre-commit to check your changes before committing