Move flake8 configuration to dedicated file

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
kedro-org · Jul 27, 2023 · 5de5443 · 5de5443
1 parent 388668a
commit 5de5443
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 9 deletions.
diff --git a/docs/source/deployment/airflow_astronomer.md b/docs/source/deployment/airflow_astronomer.md
@@ -74,7 +74,7 @@ To follow this tutorial, ensure you have the following:
     ├── plugins
     ├── pyproject.toml
     ├── requirements.txt
-    ├── setup.cfg
+    ├── .flake8
     └── src
     ```
 

diff --git a/docs/source/development/linting.md b/docs/source/development/linting.md
@@ -60,7 +60,7 @@ It is a good practice to [split your line when it is too long](https://beta.ruff
 
 #### Configure `flake8`
 
-Store your `flake8` configuration in a file named `setup.cfg` within your project root. The Kedro starters use the [following configuration](https://github.com/kedro-org/kedro-starters/blob/main/pandas-iris/%7B%7B%20cookiecutter.repo_name%20%7D%7D/setup.cfg):
+Store your `flake8` configuration in a file named `.flake8` within your project root. The Kedro starters use the [following configuration](https://github.com/kedro-org/kedro-starters/blob/main/pandas-iris/%7B%7B%20cookiecutter.repo_name%20%7D%7D/.flake8):
 
 ```text
 [flake8]

diff --git a/docs/source/get_started/kedro_concepts.md b/docs/source/get_started/kedro_concepts.md
@@ -72,7 +72,7 @@ project-dir         # Parent directory of the template
 ├── notebooks       # Project-related Jupyter notebooks (can be used for experimental code before moving the code to src)
 ├── pyproject.toml  # Identifies the project root and contains configuration information
 ├── README.md       # Project README
-├── setup.cfg       # Configuration options for `pytest` when doing `kedro test` and for the `isort` utility when doing `kedro lint`
+├── .flake8         # Configuration options for `flake8` (linting)
 └── src             # Project source code
 ```
 

diff --git a/docs/source/kedro_project_setup/starters.md b/docs/source/kedro_project_setup/starters.md
@@ -155,7 +155,7 @@ Here is the layout of the project as a Cookiecutter template:
 ├── docs                         # Project documentation
 ├── notebooks                    # Project related Jupyter notebooks (can be used for experimental code before moving the code to src)
 ├── README.md                    # Project README
-├── setup.cfg                    # Configuration options for tools e.g. `pytest` or `black`
+├── .flake8                      # Configuration options for `flake8` (linting)
 └── src                          # Project source code
     └── {{ cookiecutter.python_package }}
        ├── __init.py__

diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/.flake8 b/features/steps/test_starter/{{ cookiecutter.repo_name }}/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203
diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/setup.cfg b/features/steps/test_starter/{{ cookiecutter.repo_name }}/setup.cfg