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 3e8b886a authored by Dorian Turba's avatar Dorian Turba
Browse files

All other markdown fix

parent 69d0f13b
No related branches found
No related tags found
No related merge requests found
Pipeline #23983 passed
...@@ -27,4 +27,5 @@ QUALITY = [ ...@@ -27,4 +27,5 @@ QUALITY = [
[tool.pymarkdown] [tool.pymarkdown]
strict-config = true strict-config = true
plugins.line-length.line_length = 88 plugins.line-length.enabled = false
[![Black Logo](https://raw.githubusercontent.com/psf/black/main/docs/_static/logo2-readme.png)](https://black.readthedocs.io/en/stable/) # black template
## Objective ## Objective
......
# flake8 template
## Objective ## Objective
Run [Flake8](https://flake8.pycqa.org/en/latest/) and its plugins on your Python code to Run [Flake8](https://flake8.pycqa.org/en/latest/) and its plugins on your Python code to
......
# isort Template
## Objective ## Objective
Run [isort](https://pycqa.github.io/isort/) on your Python code to automatically sort and organize Run [isort](https://pycqa.github.io/isort/) on your Python code to automatically sort
your imports. isort separates imports into sections and by type. It's a helpful tool to ensure that and organize your imports. isort separates imports into sections and by type. It's a
your code remains clean and readable. helpful tool to ensure that your code remains clean and readable.
## How to use it ## How to use it
1. Configure the `pyproject.toml` or `.isort.cfg` file in your repository's root directory with your 1. Configure the `pyproject.toml` or `.isort.cfg` file in your repository's root
desired rules. directory with your desired rules.
2. Include the isort template in your CI/CD configuration (see quick use above). 2. Include the isort template in your CI/CD configuration (see quick use above).
3. If you need to customize the job, check 3. If you need to customize the job, check
the [jobs customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization). the [jobs customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization).
## Variables ## Variables
| Name | Description | Default | | Name | Description | Default |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| |----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| `PROJECT_PATH` | The path to the project root directory. | `"."` | | `PROJECT_PATH` | The path to the project root directory. | `"."` |
| `IMAGE_TAG` | The default tag for the docker image. See [Python Docker Official Image](https://hub.docker.com/_/python) for supported tags and respective Dockerfile links. | `"latest"` | | `IMAGE_TAG` | The default tag for the docker image. See [Python Docker Official Image](https://hub.docker.com/_/python) for supported tags and respective Dockerfile links. | `"latest"` |
| `PYTHON_SETUP` | Bash commands to setup your python environment. | `"pip install isort"` | | `PYTHON_SETUP` | Bash commands to setup your python environment. | `"pip install isort"` |
## Global Configuration of isort ## Global Configuration of isort
To add configuration to `isort` shared with any other usage of isort (such as manual run, To add configuration to `isort` shared with any other usage of isort (such as manual
pre-commit, etc), you can use `pyproject.toml` configuration file or a dedicated `.isort.cfg`. Learn run, pre-commit, etc), you can use `pyproject.toml` configuration file or a
more about [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files.html) dedicated `.isort.cfg`. Learn more
about [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files.html)
files. files.
## Add a [![Imports: isort](https://img.shields.io/badge/imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) badge to your project README.md ## Add a [![Imports: isort](https://img.shields.io/badge/imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) badge to your project README.md
To display the use of isort in your project, you can add the following badge to your README.md: To display the use of isort in your project, you can add the following badge to your
README.md:
```markdown ```markdown
[![Imports: isort](https://img.shields.io/badge/imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) [![Imports: isort](https://img.shields.io/badge/imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
......
# mypy template
## Objective ## Objective
Run [mypy](https://mypy.readthedocs.io/en/stable/) on your Python code to perform static typing Run [mypy](https://mypy.readthedocs.io/en/stable/) on your Python code to perform static typing
......
# ruff template
## Objective ## Objective
Run [Ruff](https://github.com/astral-sh/ruff), an extremely fast Python linter, on your Python Run [Ruff](https://github.com/astral-sh/ruff), an extremely fast Python linter, on your Python
......
# python install template
## Objective ## Objective
The objective of the `python_install` job is to provide a Python environment with all requirements The objective of the `python_install` job is to provide a Python environment with all requirements
......
# pytest template
## Objective ## Objective
Run [pytest](https://docs.pytest.org/en/latest/) on your Python code to ensure all unit tests pass. Run [pytest](https://docs.pytest.org/en/latest/) on your Python code to ensure all unit tests pass.
...@@ -48,7 +50,7 @@ pytest_3.10: ...@@ -48,7 +50,7 @@ pytest_3.10:
IMAGE_TAG: "3.10" IMAGE_TAG: "3.10"
``` ```
https://docs.r2devops.io/get-started/use-templates/#multiple-usage-of-the-same-job-template-in-your-pipeline [docs.r2devops: 🎶 Multiple usage of the same job template in your pipeline](https://docs.r2devops.io/get-started/use-templates/#multiple-usage-of-the-same-job-template-in-your-pipeline)
## Add a [![Tested with pytest](https://img.shields.io/badge/Tested%20with-pytest-green)](https://docs.pytest.org/en/latest/) badge to your project README.md ## Add a [![Tested with pytest](https://img.shields.io/badge/Tested%20with-pytest-green)](https://docs.pytest.org/en/latest/) badge to your project README.md
......
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