Style and Formatting

Code Style

• black: Formatting Python code
• ruff: Formatting and sorting import statements
• shellcheck: Linting shell scripts
• shfmt: Formatting shell scripts
• statix: Linting nix files
• nixpkgs-fmt: Formatting nix files

Tip

If you use nix-shell, all of these are already setup for you and ready to use, and you don't need to do anything to install these tools.

We use numpydoc as our standard format for docstrings.

---

Last update: December 28, 2022