Add pre-commit config

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+exclude: '^docs/conf.py'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-added-large-files
+  - id: check-ast
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-xml
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: requirements-txt-fixer
+  - id: mixed-line-ending
+    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+- repo: https://github.com/PyCQA/docformatter
+  rev: v1.7.5
+  hooks:
+    - id: docformatter
+      additional_dependencies: [tomli]
+      args: [--in-place, --wrap-descriptions=120, --wrap-summaries=120]
+      # --config, ./pyproject.toml
+
+- repo: https://github.com/psf/black
+  rev: 24.4.0
+  hooks:
+  - id: black
+    language_version: python3
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.3.7
+  hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
+
+## If like to embrace black styles even in the docs:
+# - repo: https://github.com/asottile/blacken-docs
+#   rev: v1.13.0
+#   hooks:
+#   - id: blacken-docs
+#     additional_dependencies: [black]
+
+## Check for misspells in documentation files:
+# - repo: https://github.com/codespell-project/codespell
+#   rev: v2.2.5
+#   hooks:
+#   - id: codespell

pyproject.toml

@@ -7,3 +7,18 @@ build-backend = "setuptools.build_meta"
 # For smarter version schemes and other configuration options,
 # check out https://github.com/pypa/setuptools_scm
 version_scheme = "no-guess-dev"
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+exclude = ["tests"]
+extend-ignore = ["F821"]
+
+[tool.ruff.pydocstyle]
+convention = "google"
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+
+[tool.black]
+force-exclude = "__init__.py"