Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit 8366519f authored by Dorian Turba's avatar Dorian Turba
Browse files

rename package_black to black_code_formatter

parent 88e2f677
No related branches found
No related tags found
No related merge requests found
......@@ -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">
......
files:
template: ./package_black.yml
template: ./black_code_formatter.yml
documentation: ./README.md
data:
description: "Run black on a package"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment