Feldfreund DevKit

TODO

Tech Stack

• Python 3.11+
• NiceGUI for web interface
• Poetry for dependency management
• RoSys framework
• Copier for template configuration (from nicegui-template)

Development

1. create a virtual environment and activate it:

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

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

2. install dependencies:

poetry install --with dev,test

3. start your project:

poetry run ./main.py

4. run your tests:

poetry run pytest

Updating template settings

To update your project configuration from the nicegui-template, run:

copier update --skip-answered

This will prompt you to review and update your template settings interactively.

pre-commit

pre-commit is a tool to help you manage and run pre-commit hooks in your code. It is used to check your code for e.g. extra whitespace or formatting errors before committing it. Install the pre-commit hooks by running:

pre-commit install

You can also run the hooks manually by running:

pre-commit run --all-files