1.7 KiB
1.7 KiB
Version control integration
Use pre-commit. Once you
have it installed, add this to the
.pre-commit-config.yaml
in your repository:
repos:
- repo: https://github.com/psf/black
rev: 23.7.0
hooks:
- id: black
# It is recommended to specify the latest version of Python
# supported by your project here, or alternatively use
# pre-commit's default_language_version, see
# https://pre-commit.com/#top_level-default_language_version
language_version: python3.11
Feel free to switch out the rev
value to something else, like another
tag/version or even a specific commit. Although we discourage the use of
branches or other mutable refs since the hook won't auto update as you may
expect.
Jupyter Notebooks
There is an alternate hook black-jupyter
that expands the targets of black
to
include Jupyter Notebooks. To use this hook, simply replace the hook's id: black
with
id: black-jupyter
in the .pre-commit-config.yaml
:
repos:
- repo: https://github.com/psf/black
rev: 23.7.0
hooks:
- id: black-jupyter
# It is recommended to specify the latest version of Python
# supported by your project here, or alternatively use
# pre-commit's default_language_version, see
# https://pre-commit.com/#top_level-default_language_version
language_version: python3.11
The `black-jupyter` hook became available in version 21.8b0.