docs/version_control_integration.md

   1 [//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM README.md"
   2
   3 # Version control integration
   4
   5 Use [pre-commit](https://pre-commit.com/). Once you
   6 [have it installed](https://pre-commit.com/#install), add this to the
   7 `.pre-commit-config.yaml` in your repository:
   8
   9 ```yaml
  10 repos:
  11   - repo: https://github.com/psf/black
  12     rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
  13     hooks:
  14       - id: black
  15         language_version: python3 # Should be a command that runs python3.6+
  16 ```
  17
  18 Then run `pre-commit install` and you're ready to go.
  19
  20 Avoid using `args` in the hook. Instead, store necessary configuration in
  21 `pyproject.toml` so that editors and command-line usage of Black all behave consistently
  22 for your project. See _Black_'s own
  23 [pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an
  24 example.
  25
  26 If you're already using Python 3.7, switch the `language_version` accordingly. Finally,
  27 `stable` is a branch that tracks the latest release on PyPI. If you'd rather run on
  28 master, this is also an option.