Pre-commit hooks

Hartree Centre pre-commit hooks to use across multiple projects - these have been developed to hopefully make life simpler, so please raise an issue on our repository if you’re finding they’re more hassle than you’d like!

Documentation for our current hooks are available on the left hand side of this page.

example configuration:

.pre-commit-config.yaml

repos:
    - repo: https://github.com/stfc/pre-commit-hooks
      rev: v0.3.7
      hooks:
        - id: check-mypy-import-errors
        - id: check-pylint-import-errors

TODO: add a worked example of creating a new hook

TODO: add instructions on how to use these hooks within pre-commit-config.yaml

Hooks:

• Check Missing Requirements
• Check MyPy Import Errors
• Check Pylint Import Errors

Functionality:

• Base Hook Definition
• Setup.cfg File Handling

Indices and tables

• Index

• Module Index

• Search Page