docs/integrations/source_version_control.md

   1 # Version control integration
   2
   3 Use [pre-commit](https://pre-commit.com/). Once you
   4 [have it installed](https://pre-commit.com/#install), add this to the
   5 `.pre-commit-config.yaml` in your repository:
   6
   7 ```yaml
   8 repos:
   9   # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
  10   - repo: https://github.com/psf/black-pre-commit-mirror
  11     rev: 23.10.0
  12     hooks:
  13       - id: black
  14         # It is recommended to specify the latest version of Python
  15         # supported by your project here, or alternatively use
  16         # pre-commit's default_language_version, see
  17         # https://pre-commit.com/#top_level-default_language_version
  18         language_version: python3.11
  19 ```
  20
  21 Feel free to switch out the `rev` value to a different version of Black.
  22
  23 Note if you'd like to use a specific commit in `rev`, you'll need to swap the repo
  24 specified from the mirror to https://github.com/psf/black. We discourage the use of
  25 branches or other mutable refs since the hook [won't auto update as you may
  26 expect][pre-commit-mutable-rev].
  27
  28 ## Jupyter Notebooks
  29
  30 There is an alternate hook `black-jupyter` that expands the targets of `black` to
  31 include Jupyter Notebooks. To use this hook, simply replace the hook's `id: black` with
  32 `id: black-jupyter` in the `.pre-commit-config.yaml`:
  33
  34 ```yaml
  35 repos:
  36   # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
  37   - repo: https://github.com/psf/black-pre-commit-mirror
  38     rev: 23.10.0
  39     hooks:
  40       - id: black-jupyter
  41         # It is recommended to specify the latest version of Python
  42         # supported by your project here, or alternatively use
  43         # pre-commit's default_language_version, see
  44         # https://pre-commit.com/#top_level-default_language_version
  45         language_version: python3.11
  46 ```
  47
  48 ```{note}
  49 The `black-jupyter` hook became available in version 21.8b0.
  50 ```
  51
  52 [pre-commit-mutable-rev]:
  53   https://pre-commit.com/#using-the-latest-version-for-a-repository