diff --git a/pyproject.toml b/pyproject.toml index 96d8c590e9cc4fbb108fb55e20fcb7ac5176c72b..8e52531e530ce394f08c59a2e551d8907b3c3915 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,4 +27,5 @@ QUALITY = [ [tool.pymarkdown] strict-config = true -plugins.line-length.line_length = 88 +plugins.line-length.enabled = false + diff --git a/templates/python/code_quality/black/README.md b/templates/python/code_quality/black/README.md index df6162a9cfcad7d2371b813722400443f7e830ed..1c62c1f57b2ceab1d9c39c7706e80d4e96e4c6ab 100644 --- a/templates/python/code_quality/black/README.md +++ b/templates/python/code_quality/black/README.md @@ -1,4 +1,4 @@ -[](https://black.readthedocs.io/en/stable/) +# black template ## Objective diff --git a/templates/python/code_quality/flake8/README.md b/templates/python/code_quality/flake8/README.md index 6da44b43863e0028c9bcea553cc2d350f341592a..1eb5416c2fea570dc5587f91a377838855754636 100644 --- a/templates/python/code_quality/flake8/README.md +++ b/templates/python/code_quality/flake8/README.md @@ -1,3 +1,5 @@ +# flake8 template + ## Objective Run [Flake8](https://flake8.pycqa.org/en/latest/) and its plugins on your Python code to diff --git a/templates/python/code_quality/isort/README.md b/templates/python/code_quality/isort/README.md index d387150feeb6219890509cb7fdee15c6b1b50748..6e09f458c1c2300e856baf19c7a2d3a6f8b40653 100644 --- a/templates/python/code_quality/isort/README.md +++ b/templates/python/code_quality/isort/README.md @@ -1,35 +1,39 @@ +# isort Template + ## Objective -Run [isort](https://pycqa.github.io/isort/) on your Python code to automatically sort and organize -your imports. isort separates imports into sections and by type. It's a helpful tool to ensure that -your code remains clean and readable. +Run [isort](https://pycqa.github.io/isort/) on your Python code to automatically sort +and organize your imports. isort separates imports into sections and by type. It's a +helpful tool to ensure that your code remains clean and readable. ## How to use it -1. Configure the `pyproject.toml` or `.isort.cfg` file in your repository's root directory with your - desired rules. +1. Configure the `pyproject.toml` or `.isort.cfg` file in your repository's root + directory with your desired rules. 2. Include the isort template in your CI/CD configuration (see quick use above). 3. If you need to customize the job, check the [jobs customization](https://docs.r2devops.io/get-started/use-templates/#job-templates-customization). ## Variables -| Name | Description | Default | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| -| `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"` | -| `PYTHON_SETUP` | Bash commands to setup your python environment. | `"pip install isort"` | +| Name | Description | Default | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| `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"` | +| `PYTHON_SETUP` | Bash commands to setup your python environment. | `"pip install isort"` | ## Global Configuration of isort -To add configuration to `isort` shared with any other usage of isort (such as manual run, -pre-commit, etc), you can use `pyproject.toml` configuration file or a dedicated `.isort.cfg`. Learn -more about [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files.html) +To add configuration to `isort` shared with any other usage of isort (such as manual +run, pre-commit, etc), you can use `pyproject.toml` configuration file or a +dedicated `.isort.cfg`. Learn more +about [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files.html) files. ## Add a [](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 [](https://pycqa.github.io/isort/) diff --git a/templates/python/code_quality/mypy/README.md b/templates/python/code_quality/mypy/README.md index 27079af443fd3c46e7e5290f4809fb33cf009536..19e87695f37ccc54025d84f0ccf57d045813611c 100644 --- a/templates/python/code_quality/mypy/README.md +++ b/templates/python/code_quality/mypy/README.md @@ -1,3 +1,5 @@ +# mypy template + ## Objective Run [mypy](https://mypy.readthedocs.io/en/stable/) on your Python code to perform static typing diff --git a/templates/python/code_quality/ruff/README.md b/templates/python/code_quality/ruff/README.md index 7dda7b11ddbe9f9d17ead4db013b2dc5dd5cbd6a..43fe292d015ad3fae96f9721fb3911652bbd63b3 100644 --- a/templates/python/code_quality/ruff/README.md +++ b/templates/python/code_quality/ruff/README.md @@ -1,3 +1,5 @@ +# ruff template + ## Objective Run [Ruff](https://github.com/astral-sh/ruff), an extremely fast Python linter, on your Python diff --git a/templates/python/partial/python_install/README.md b/templates/python/partial/python_install/README.md index c8147543374d6c8b9e4f991262902a3444ad2ce1..8514bd0885972cddd243d2bb7dc06f677d9f5149 100644 --- a/templates/python/partial/python_install/README.md +++ b/templates/python/partial/python_install/README.md @@ -1,3 +1,5 @@ +# python install template + ## Objective The objective of the `python_install` job is to provide a Python environment with all requirements diff --git a/templates/python/testing/pytest/README.md b/templates/python/testing/pytest/README.md index 513169c0c687b8e39d7e3edcb030b620b71e16a4..259a79201d25c8bca0b094db53746c36bb1316c7 100644 --- a/templates/python/testing/pytest/README.md +++ b/templates/python/testing/pytest/README.md @@ -1,3 +1,5 @@ +# pytest template + ## Objective 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: 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 [](https://docs.pytest.org/en/latest/) badge to your project README.md