Skip to content

Ingenjorsarbete-For-Klimatet/ifk-python-template

Repository files navigation

ifk-python-template

Python: 3.9 - 3.12 Testing framework: pytest Linter and formatter: ruff Type checker: mypy

Description

Welcome to ifk-python-template.

Configuration

When you start a new project, apart from the obvious changes, there are some details to consider.

  • Build workflow, follow the guide in dynamic badges.
  • To build docs, change branch in github/workflows/github-action-docs.yaml. from ["SET_TO_MAIN"] to ["main"]. You also need to activate Pages under repo Settings/Pages.
  • Install copier (install pipx through pip) as
pipx install copier

and then do

copier copy https://github.com/Ingenjorsarbete-For-Klimatet/ifk-python-template.git /path/to/project-name

Copier supports updating projects based on templates when the template updates. See copier docs.

About

Template for python based projects.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •