Update config files and post hook installation messages (#5)

* Updating post hook debug messages and adding pytest and coverage to pre-commit hook

* Excluding toml and yaml files from project_slug due to presence of jinja syntax

Author: gurashish1singh

.pre-commit-config.yaml

@@ -10,8 +10,10 @@ repos:
         stages: [push]
     -   id: check-toml
         stages: [push]
+        exclude: "{{ cookiecutter.project_slug }}/pyproject.toml"
     -   id: check-yaml
         stages: [push]
+        exclude: "{{ cookiecutter.project_slug }}/.pre-commit-config.yaml"
     -   id: end-of-file-fixer
         stages: [push]
     -   id: trailing-whitespace
@@ -28,18 +30,19 @@ repos:
     -   id: flake8
         name: Running flake8 from local poetry env
         entry: poetry run flake8 .
-        language: python
+        language: system
         files: ".*.py"
         exclude: "{{ cookiecutter.project_slug }}"
     -   id: isort
         name: Running isort from local poetry env
         entry: poetry run isort .
-        language: python
+        language: system
         files: ".*.py"
         exclude: "{{ cookiecutter.project_slug }}"
     -   id: lizard
         name: Running lizard from local poetry env
         entry: poetry run lizard
         # Max 7 arguments allowed, show only warnings, sort by CCN, exclude .venv
         args: ["--CCN", "8", "-a", "7", "-w", "-s", "cyclomatic_complexity", "-x", ".\\.venv\\*"]
-        language: python
+        language: system
+        files: ".*.py"

README.md

@@ -34,7 +34,9 @@ A [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Py
     python -m cookiecutter https://github.com/gurashish1singh/cookiecutter-python.git
     ```
 - This template uses post-project generation hooks to:
-   - Initialize a git repository (with default branch as main), IF the working directory is not already a git repository
+   - Initialize a git repository (with default branch as main), IF the working directory is not already a git repository.
+
+     **NOTE**: You will have to create a repositry on remote if it doesn't already exist before running the cookiecutter command.
    - Create a Poetry virtualenv
    - Install all dependencies
    - Install the pre-commit and pre-push hooks

hooks/post_gen_project.py

@@ -6,20 +6,20 @@
 import sys
 from pathlib import Path
 
-ERROR_MSG = "Error occured while running cmd"
+ERROR_MSG = "Error occured while running command"
 PRETTY_LINES = "*" * 80
 
 
 def main() -> int:
     working_dir = Path().resolve()
     git_dir = Path(working_dir, ".git")
-    ret_code_one = 0
+    return_code_one = 0
     if not git_dir.exists():
-        ret_code_one = initialize_git()
+        return_code_one = initialize_git()
 
-    if ret_code_one == 0:
-        ret_code_two = setup_environment()
-    return ret_code_one or ret_code_two or 0
+    if return_code_one == 0:
+        return_code_two = setup_environment()
+    return 0 or return_code_one or return_code_two
 
 
 def initialize_git() -> int:
@@ -30,7 +30,8 @@ def initialize_git() -> int:
         ),
         "init_git": (
             shlex.split("git init"),
-            "Initializing an empty git repository\n",
+            "Initializing an empty git repository locally. You will have to create a repo "
+            "on remote.\n",
         ),
     }
     for cmds, message in COMMANDS_AND_MESSAGE.values():

{{ cookiecutter.project_slug }}/.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+#!/bin/bash
 default_stages: [commit]
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
@@ -37,7 +38,26 @@ repos:
         files: ".*.py"
     -   id: lizard
         name: Running lizard from local poetry env
-        entry: poetry run lizard .
+        entry: poetry run lizard
         # Max 7 arguments allowed, show only warnings, sort by CCN, exclude .venv
         args: ["--CCN", "8", "-a", "7", "-w", "-s", "cyclomatic_complexity", "-x", ".\\.venv\\*"]
         language: python
+    {% if cookiecutter.pytest == "y" -%}
+    -   id: pytest
+        name: Running tests using pytest from local poetry env
+        entry: poetry run coverage run -m pytest
+        args: ["-x"]
+        language: system
+        types:
+          - python
+        pass_filenames: false
+        stages: [push]
+    -   id: coverage
+        name: Generating coverage report
+        entry: poetry run coverage report -m
+        language: system
+        types:
+          - python
+        pass_filenames: false
+        stages: [push]
+    {%- endif %}

{{ cookiecutter.project_slug }}/pyproject.toml

@@ -40,6 +40,9 @@ plugins = ["covdefaults"]
 
 [tool.coverage.report]
 fail_under = 95
+omit = [
+    "logger.py"
+]
 {%- endif %}
 
 [build-system]