diff --git a/python/quality/package_black/README.md b/python/quality/black_code_formatter/README.md similarity index 74% rename from python/quality/package_black/README.md rename to python/quality/black_code_formatter/README.md index ebe8a8cbb3c57d6877116380e648a45e19e58295..91cac5cf83f1f0ff9101c2c6fd84238cc15b4109 100644 --- a/python/quality/package_black/README.md +++ b/python/quality/black_code_formatter/README.md @@ -2,16 +2,16 @@ ## Objective -Run [Black](https://github.com/psf/black) on your Python code to ensure it complies with the coding -style guide. +Run the [Black code formatter](https://github.com/psf/black) on your Python code to ensure it +complies with the coding style guide. ## How to use it -1. Create a [python package](https://packaging.python.org/en/latest/tutorials/packaging-projects/). 2. Include template in your CI/CD conf (see quick use above) 3. Customize the template if it's relevant ## 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"> <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"> diff --git a/python/quality/package_black/package_black.r2.yml b/python/quality/black_code_formatter/black_code_formatter.r2.yml similarity index 84% rename from python/quality/package_black/package_black.r2.yml rename to python/quality/black_code_formatter/black_code_formatter.r2.yml index 8e170fa54ddb09c4421f177158d33574939db739..915d102cdd6703bc9f60a2146217210ac2d210c9 100644 --- a/python/quality/package_black/package_black.r2.yml +++ b/python/quality/black_code_formatter/black_code_formatter.r2.yml @@ -1,5 +1,5 @@ files: - template: ./package_black.yml + template: ./black_code_formatter.yml documentation: ./README.md data: description: "Run black on a package" diff --git a/python/quality/package_black/package_black.yml b/python/quality/black_code_formatter/black_code_formatter.yml similarity index 100% rename from python/quality/package_black/package_black.yml rename to python/quality/black_code_formatter/black_code_formatter.yml