Python Stack
Python

Python Stack

Research-Grade Coding Practices

8th September, 2024

Here are my recommendations for how to write/organize code (targeted at Python).

Here is me talking about CI and the rest of this for 30 minutes: Code Practices Talk

Here are my recommendations of things to do/use (roughly in order of importance):

  • CI/CD Pipeline
  • Make your repo a Python Package
  • Use Pytest in CI Pipeline
  • Protect your Main Branch
  • Make people write tests for any new feature they introduce
  • Make people write documentation for all code they write. This can either be in the README.md or using something like Sphinx, which autobuilds a documentation website from your docs.
  • Use black and flake8.
  • Conventional Commits
  • Use Test-Driven Development