Removing flake8 dependency and including ruff

Author: nullhack

cookiecutter.json

@@ -7,6 +7,8 @@
   "package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_').replace('project', 'package') }}",
   "module_name": "{{ cookiecutter.package_name.lower().replace(' ', '_').replace('-', '_').replace('package', 'module') }}",
   "project_short_description": "Python template with some awesome tools to quickstart any Python project",
+  "minimum_coverage": 100,
+  "include_examples": "true",
   "version": "0.1.0",
   "license": ["MIT", "BSD_3_Clause", "Apache_2.0", "GPL_3.0", "Proprietary"]
 }

{{cookiecutter.project_slug}}/.flake8

@@ -1,3 +1,10 @@
+"""This module generates readme and feature files for mkdocs.
+
+As part of the mkdocs-gen-file plugin, this module helps to automate
+readme generation using the README file and feature pages using the feature
+files if they do exist.
+"""
+
 from pathlib import Path
 
 import mkdocs_gen_files
@@ -7,9 +14,10 @@
 # Automagically injects README file into the documentation
 readme_path = docs_parent_dir / "README.md"
 if readme_path.exists():
-    with open(readme_path, "r") as r:
-        with mkdocs_gen_files.open("readme.md", "w") as f:
-            f.write(r.read())
+    with open(readme_path, "r") as r, mkdocs_gen_files.open(
+        "readme.md", "w"
+    ) as f:
+        f.write(r.read())
 
 
 # Injects feature files into the documentation
@@ -31,9 +39,9 @@
         ) as gf:
             f_line_list = f.readlines()
             for line in f_line_list:
-                if any([line.strip().startswith(l) for l in head_lines]):
+                if any([line.strip().startswith(hl) for hl in head_lines]):
                     write_line = f"### {line}\n"
-                elif any([line.strip().startswith(l) for l in ignore_lines]):
+                elif any([line.strip().startswith(il) for il in ignore_lines]):
                     continue
                 else:
                     write_line = f">    {line}"

{{cookiecutter.project_slug}}/docs/gen_pages.py

@@ -18,14 +18,14 @@ theme:
   name: material
   palette:
   - media: '(prefers-color-scheme: light)'
-    scheme: slate
+    scheme: default
     primary: blue
     accent: amber
     toggle:
       icon: material/lightbulb-outline
       name: Switch to light mode
   - media: '(prefers-color-scheme: dark)'
-    scheme: default
+    scheme: slate
     primary: black
     accent: amber
     toggle:

{{cookiecutter.project_slug}}/docs/mkdocs.yaml

@@ -17,32 +17,13 @@ python = "^3.10"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^2.18.1"
-isort = "^5.10.1"
 black = {version = "^22.3.0", allow-prereleases = true}
 xdoctest = "^1.0.0"
-Pygments = "^2.11.2"
-darglint = "^1.8.1"
-pylint = "^2.13.4"
 poethepoet = "^0.16.4"
-mypy = "^0.942"
-flake8 = "^4.0.1"
-flake8-docstrings = "^1.6.0"
-flake8-todos = "^0.1.5"
-flake8-logging-format = "^0.6.0"
-flake8-builtins = "^1.5.3"
-flake8-pytest-style = "^1.6.0"
-flake8-bugbear = "^22.3.23"
-flake8-bandit = "^3.0.0"
-flake8-annotations = "^2.8.0"
-flake8-black = "^0.3.2"
-flake8-mypy = "^17.8.0"
-flake8-simplify = "^0.19.3"
-flake8-isort = "^5.0.0"
-pep8-naming = "^0.12.1"
+ruff = "^0.0.253"
 pytest = "7.1.1"
 pytest-html = "^3.1.1"
 pytest-sugar = "^0.9.6"
-pytest-flake8 = "^1.1.1"
 pytest-reverse = "^1.5.0"
 pytest-cov = "^3.0.0"
 pytest-bdd = "^6.1.1"
@@ -51,59 +32,70 @@ mkdocs-material = "^8.5.10"
 mkdocs-gen-files = "^0.4.0"
 mkdocs-awesome-pages-plugin = "^2.8.0"
 mkapi = "^1.0.14"
-mako = "^1.2.3"
 
 [tool.poetry.scripts]
--x = "poethepoet:main"
+-c = "poethepoet:main"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-line_length = 79
-
 [tool.black]
 line-length = 79
 target-version = ['py310']
 include = '\.pyi?$'
-exclude = '''
 
-(
-  /(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.hg
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | _build
-    | buck-out
-    | build
-    | dist
-    | docs
-  )/
-  | foo.py           # also separately exclude a file named foo.py in
-                     # the root of the project
-)
-'''
+[tool.ruff]
+exclude = [
+    "docs/",
+    ".git",
+    ".nox",
+    "__pycache__",
+    "docs/source/conf.py",
+    "old",
+    "build",
+    "dist",
+]
+ignore = ["E501"]
+line-length = 79
+select = [
+    "C9",
+    "E",
+    "F",
+    "W",
+    "D",
+    "G",
+    "A",
+    "PT",
+    "S",
+    "B",
+    "ANN",
+    "SIM",
+    "I",
+    "N",
+]
+
+
+[tool.ruff.mccabe]
+max-complexity = 10
+
+[tool.ruff.pydocstyle]
+convention = "google"
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["S101"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = """
 --verbose \
 --maxfail=1 \
---flake8 \
 --reverse \
 --color=yes \
 --cov={{cookiecutter.package_name}} \
 --html=docs/pytest_report.html \
 --self-contained-html \
---cov-fail-under=100 \
+--cov-fail-under={{cookiecutter.minimum_coverage}} \
 --cov-report term-missing \
 --cov-report html:docs/cov-report \
 --doctest-modules \
@@ -129,26 +121,15 @@ exclude_lines = [
     "if __name__ == .__main__.:"
     ]
 
-[tool.mypy]
-warn_return_any = true
-warn_unused_configs = true
-warn_redundant_casts = true
-disallow_untyped_defs = true
-disallow_any_generics = true
-disallow_incomplete_defs = true
-no_implicit_optional = true
-warn_unused_ignores = true
-show_error_context = true
-error_summary = true
-pretty = true
-
 [tool.poe.tasks]
 install = "poetry install --only main"
 install-dev = "poetry install"
 run = "python -m {{cookiecutter.package_name}}.{{cookiecutter.module_name}}"
 test = "pytest"
 pre-commit = "pre-commit run --all-files"
-lint = "flake8"
+lint-ruff = "ruff check **/*.py --fix"
+lint-black = "black **/*.py"
+lint = ["lint-black", "lint-ruff"]
 doc = "mkdocs serve --use-directory-urls -f docs/mkdocs.yaml"
 doc-html = "mkdocs build --no-directory-urls -f docs/mkdocs.yaml"
 doc-publish = """mkdocs gh-deploy \
@@ -171,4 +152,3 @@ args = [
   { name = "build-platform", default = "linux/amd64" },
   { name = "target", default = "prod" },
 ]
-

{{cookiecutter.project_slug}}/poetry.lock

@@ -21,9 +21,12 @@ def pytest_configure(config: pytest.Config) -> None:
 
     """
     conftest_dir = Path(__file__).parent
-    caller_module_path = get_caller_module_path()
-    features_base_dir = get_features_base_dir(caller_module_path)
-    features = get_features([features_base_dir])
+    caller_module_path = Path(get_caller_module_path())
+    features_base_dir = Path(get_features_base_dir(caller_module_path))
+    if features_base_dir.exists():
+        features = get_features([features_base_dir])
+    else:
+        features = []
 
     for feat in features:
 

{{cookiecutter.project_slug}}/pyproject.toml

@@ -1,4 +1,4 @@
-"""This file contains examples of how to write tests using pytest!
+{%- if cookiecutter.include_examples == "true" -%}"""This file contains examples of how to write tests using pytest!
 
 Some good practices for writting great Python tests:
 
@@ -95,3 +95,5 @@ def test_divide_error(
     """
     with pytest.raises(expected):
         m.Calculator.divide(a, b)
+{%- elif cookiecutter.include_examples != "true" -%}
+"""Pytest test module."""{% endif %}

{{cookiecutter.project_slug}}/tests/scenarios/conftest.py

@@ -1,11 +1,12 @@
+{%- if cookiecutter.include_examples == "true" -%}
 """Module Docstring."""
 
 import logging
 
 # TODO({{cookiecutter.full_name}}): Check how to write todos!
 # https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues/1337
 
-logger = logging.getLogger("test")
+logger = logging.getLogger("{{cookiecutter.module_name}}")
 logger.info("This is a {word}", extra={"word": "Log"})
 
 
@@ -43,3 +44,13 @@ def divide(a: float, b: float) -> float:
 
 if __name__ == "__main__":
     print("RUNNING!")
+{%- elif cookiecutter.include_examples != "true" -%}
+"""Module Docstring."""
+
+import logging
+
+logger = logging.getLogger("{{cookiecutter.module_name}}")
+
+
+if __name__ == "__main__":
+    print("RUNNING!"){% endif %}