add black

.gitlab-ci.yml

@@ -4,6 +4,7 @@ stages:
 include:
     - local: 'templates/python/testing/pytest/pytest.yml'
     - local: 'templates/python/code_quality/flake8/flake8.yml'
+    - local: 'templates/python/code_quality/black/black.yml'
 
 pytest:
     stage: templates
@@ -26,3 +27,14 @@ flake8:
             - .gitlab-ci.yml
             - pyproject.toml
             - templates/python/code_quality/flake8/*
+
+black:
+    stage: templates
+    variables:
+        PROJECT_PATH: "tests/black_project"
+        PYTHON_SETUP: "pip install ${PROJECT_PATH} black"
+    only:
+        changes:
+            - .gitlab-ci.yml
+            - pyproject.toml
+            - templates/python/code_quality/black/*

templates/python/code_quality/black/black.yml

 black:
-    image: python:latest
+    image: python:${IMAGE_TAG}
     stage: code_quality
+    variables:
+        IMAGE_TAG: "latest"
+        PROJECT_PATH: "."
+        PYTHON_SETUP: "pip install ${PROJECT_PATH}[CODE_QUALITY]"
     script:
         - python --version  # Debug
         - python -m venv venv --upgrade-deps || python -m venv venv  # upgrade-deps is not supported before 3.9
         - source venv/bin/activate
-        - pip install black
-        - black . --check --diff --quiet
+        - ${PYTHON_SETUP}
+        - black ${PROJECT_PATH} --check --diff --quiet
     only:
         changes:
             - ./**/*.py

templates/python/code_quality/flake8/flake8.yml

 flake8:
-    image: python:latest
+    image: python:${IMAGE_TAG}
     stage: code_quality
+    variables:
+        IMAGE_TAG: "latest"
+        PROJECT_PATH: "."
+        PYTHON_SETUP: "pip install ${PROJECT_PATH}[CODE_QUALITY]"
     script:
         - python --version  # Debug
         - python -m venv venv --upgrade-deps || python -m venv venv  # upgrade-deps is not supported before 3.9
         - source venv/bin/activate
-        - pip install flake8
+        - ${PYTHON_SETUP}
         - flake8 ${PROJECT_PATH} -v
     only:
         changes:

tests/black_project/pyproject.toml

+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "black_project"
+version = "0.1.0"
+authors = [
+    { name = "Author Name", email = "author.name@example.com" },
+]
+description = "A description of what the package is for."

tests/black_project/src/black_project/__init__.py

+from black_project.main import main
+
+__all__ = ['main']

tests/black_project/src/black_project/main.py

+"""Sample main module."""
+
+
+def main() -> bool:
+    """Sample main function."""
+    print("Hello, world!")
+    return True
+
+
+if __name__ == '__main__':
+    main()

tests/flake8_project/src/flake8_project/__init__.py

-from test_project.main import main
+from flake8_project.main import main
 
 __all__ = ['main']