diff --git a/python/quality/package_black/README.md b/python/quality/package_black/README.md index e6da0f9ce94cf2b95fb0bff0db9975730fb06f1d..46659fe38af9da4f21173f0424ed70b02e82c3ee 100644 --- a/python/quality/package_black/README.md +++ b/python/quality/package_black/README.md @@ -1,3 +1,5 @@ +[](https://black.readthedocs.io/en/stable/) + ## Objective Run [Black](https://github.com/psf/black) on your Python code to ensure it complies with the coding @@ -9,6 +11,12 @@ style guide. 2. Include template in your CI/CD conf (see quick use above) 3. Customize the template if it's relevant +## Variables + +| Name | Description | Default | +|---------------------------|--------------------------------------------------------------------------------------------------------|---------| +| `OPTIONAL_DEPENDENCY_TAG` | If `black` is listed as a main dependency, leave variable empty, otherwise fill it with `[<TAGNAME>]`. | `""` | + ## Add <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> cartouche to your project README.md ```markdown <a href="https://github.com/psf/black"> diff --git a/python/quality/package_black/package_black.yml b/python/quality/package_black/package_black.yml index a57be02508244e181e7015c0fae7e2281bb27109..e317362ad0bd7b53b13c50de110939c892fbcc19 100644 --- a/python/quality/package_black/package_black.yml +++ b/python/quality/package_black/package_black.yml @@ -5,7 +5,7 @@ black: - python --version # Debug - python -m venv venv --upgrade-deps || python -m venv venv - source venv/bin/activate - - pip install .[QUALITY] + - pip install .[OPTIONAL_DEPENDENCY_TAG] - package_black . --check --diff --quiet only: changes: @@ -13,3 +13,5 @@ black: - tests/**/*.py - .gitlab-ci.yml - pyproject.toml + variables: + OPTIONAL_DEPENDENCY_TAG: "" \ No newline at end of file