https://github.com/zauberzeug/nicegui-template
A copier template for a basic NiceGUI project
https://github.com/zauberzeug/nicegui-template
Last synced: 6 months ago
JSON representation
A copier template for a basic NiceGUI project
- Host: GitHub
- URL: https://github.com/zauberzeug/nicegui-template
- Owner: zauberzeug
- License: mit
- Created: 2025-03-17T09:36:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-06-13T09:00:00.000Z (7 months ago)
- Last Synced: 2025-06-13T10:19:27.195Z (7 months ago)
- Language: Python
- Size: 43.9 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://pipx.pypa.io/stable/).
2. install [`copier`](https://copier.readthedocs.io/en/stable/) with pipx: `pipx install copier` (tested with `copier==9.7.1`).
## Quickstart
1. generate your project:
```bash
copier copy git@github.com:zauberzeug/nicegui-template.git path/to/project
```
2. explore your new project:
```bash
cd path/to/project
```
3. initialize a git repo:
```bash
git init
```
4. create a virtual environment:
```bash
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:
```bash
poetry install --with dev # with poetry
pip install -r requirements-dev.txt # without poetry
```
6. start your project:
```bash
./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](https://python-poetry.org/) 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](https://pre-commit.com/) to check your changes before committing |