How to use at KIT - jan-david-fischbach/python GitHub Wiki


marp: true theme: uncover class: invert

TL;DR

Setup an empty git repository first!

then run

pip install cookiecutter
cookiecutter gh:jan-david-fischbach/python

and follow the instructions


Step by Step


Step 1: New Gitlab-Repo


w:600 01_NewProject


w:600 02_NewProject2


w:600 03_Readme


w:600 04_NewProject3


Step 2 (Optional): Set up virtual environment

mamba create -n playground
conda activate playground
mamba install python=3.10

w:700 mamba


Step 3: Install and run cookiecutter

pip install cookiecutter
cookiecutter gh:jan-david-fischbach/python

Install:

w:700 pip


Run:

w:500 cookie

Use the browser URL of the repo for the package_url and the URL you'd use for cloning as the git_remote.


Done: Repo

w:500 10_works


And Now


Write README

w:500 12_VSCode_README


Add Requirements

w:500 15_Requirements


Add Source Code

w:500 20_add


Use Intellisense

w:500 25_hints


Write Tests

w:500 30_tests


w:600 32_pytest


w:600 33_tests_ui


w:600 34_fail


Enjoy CI/CD


w:600 40_Warning


w:600 41_warning-2


w:600 42_Warning3


Enjoy automated documentation


w:600 99_docs