Principles

These pages are focused on designing good software, with a focus on end-user research code. Process recommendations discusses the process of writing software, and Design recommendations covers some tips about writing easy to read and maintain code.

• Scientific Python Development Guide
• Tutorials
  • Intro to development
  • Inline documentation
  • Packaging
  • Test
  • Writing documentation
• Topical Guides
  • Testing with pytest
  • Code Coverage
  • Writing documentation
  • Simple packaging
  • Packaging Compiled Projects
  • Classic packaging
  • Style and static checks
  • Static type checking
  • GitHub Actions: Intro
  • GitHub Actions: Pure Python wheels
  • GitHub Actions: Binary wheels
  • Task runners
• Principles
  • Process recommendations
  • Design recommendations
  • Testing recommendations
• Patterns
  • Exports
  • Backports
  • Including data files
• Repo-Review