MeteoSwiss-APN Python blueprint

Getting Started

• Getting started
  • Preparation
  • Install Copier
  • Create your Python package from our template
  • Set up your project on GitHub
  • Start developing your package
  • Update template
• Contributing to the blueprint code
• FAQ and Troubleshooting

Features

• Documentation
  • Documentation template in the docs folder
• Development Tools
  • What development tools come with the Blueprint?
  • How are these tools supposed to be run?
  • Where do I customize linters, checkers, GH workflows, etc.
  • What do I need to know about versioning?
  • I write beautiful code, I don’t need an autoformatter!
  • What are pre-commit hooks?
  • Tell me about pytest!
  • Tell me about flake8!
  • Tell me about pylint!
  • Tell me about mypy!
  • Why should I want to declare variable types in Python?
• CI / CD (Jenkins and GH Actions)
  • GH Actions workflow
  • Jenkins
  • A word on tox

Indices and tables

• Index

• Module Index

• Search Page