Merge pull request #3 from adolfo-ab/add-precommit-config

Add precommit config

Author: ruivieira

.flake8

@@ -0,0 +1,27 @@
+[flake8]
+# UFN plugin must be run in serial
+jobs = 0
+max-line-length = 120
+
+exclude =
+    doc,
+    .venv,
+    .git,
+    .yml,
+    Pipfile.*,
+    docs/*,
+
+fcn_exclude_functions =
+    re,
+    logging,
+    LOGGER,
+    os,
+    json,
+    yaml,
+    pytest,
+
+enable-extensions =
+    FCN,
+    UFN,
+    NIC,
+    NIT,

.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+minimum_pre_commit_version: 3.3.0
+default_install_hook_types: [pre-commit, commit-msg]
+
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md] # Do not process Markdown files.
+      - id: end-of-file-fixer
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: check-toml
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: "7.1.2"
+    hooks:
+      - id: flake8
+        args: [--config=.flake8, '--ignore=FCN001,W503']
+        additional_dependencies:
+          [
+            "git+https://github.com/RedHatQE/[email protected]",
+            "flake8-mutable",
+          ]
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.10
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.24.0
+    hooks:
+      - id: gitleaks
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["types-PyYAML", "types-requests"]
+        exclude: ^(docs/|.*/test_.*)

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# New contributor guide
+
+## pre-commit
+
+In order to ensure proper and consistent code formatting, we use `pre-commit` in combination with tools like `ruff`, `flake8`, and `mypy`. When committing your code, make sure that all the pre-commit checks pass in your local environment.
+To install pre-commit:
+
+```bash
+pre-commit install -t pre-commit -t commit-msg
+```
+
+Run manually pre-commit:
+
+```bash
+pre-commit run --all-files
+```

pyproject.toml

@@ -18,7 +18,6 @@ requests = "^2.31.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.2"
-black = "^23.9.1"
 isort = "^5.12.0"
 flake8 = "^6.1.0"
 mypy = "^1.5.1"
@@ -29,11 +28,6 @@ httpx = "^0.25.0"
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.black]
-line-length = 88
-target-version = ["py311"]
-include = '\.pyi?$'
-
 [tool.isort]
 profile = "black"
 line_length = 88
@@ -44,8 +38,22 @@ warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
 disallow_incomplete_defs = true
+check_untyped_defs = true
+no_implicit_optional = true
+show_error_codes = true
+warn_unused_ignores = true
+
+[tool.ruff]
+preview = true
+line-length = 120
+fix = true
+output-format = "grouped"
+extend-exclude = ["utilities/manifests"]
+
+[tool.ruff.format]
+exclude = [".git", ".venv", ".mypy_cache", "__pycache__"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "test_*.py"
-python_functions = "test_*" 
+python_functions = "test_*"