Python Project Template

   A versatile template for python projects

Table of Content

• Local Execution & Configuration
  • 1. The .env File
  • 2. Running Scripts Locally
  • 3. Using CLI Overrides
• Working with the Documentation
  • How to Build the Pages Locally
  • How to Add New Content
  • Deployment to GitHub Pages
• Unit Testing
  • 1. The Triggers (on)
  • 2. Job 1: unit-tests
  • 3. Job 2: coverage
• Containers
  • Containerization & Docker / Apptainer
  • Apptainer Development Layer
• Command Line Scripts
  • Matrix Multiplier (run_matrix.py)
• API Reference
  • mypkgs