Updating the base template (#1)

* Updated the template to add a basic linting config and optional pytest installation

* Jinja-d the author name for the license

* README updates and removed the lock file

* Added post gen hook and cleaned up readme

* Poetry-ize

* Update README and spellcheck

* Removed coverage blocks from toml file

Author: gurashish1singh

.pre-commit-config.yaml

@@ -30,8 +30,16 @@ repos:
         entry: poetry run flake8 .
         language: python
         files: ".*.py"
+        exclude: "{{ cookiecutter.project_slug }}"
     -   id: isort
         name: Running isort from local poetry env
         entry: poetry run isort .
         language: python
         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

README.md

@@ -1,17 +1,32 @@
-# Placeholder Project Name
+# Cookiecutter Python Package
 
+My take on a [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package with Poetry as the dependency manager.
 
-## Initial setup
-The bash script **setup.sh** is an executable. Devs should run
-```bash
-chmod +x setup.sh
-```
-(Powershell may have different syntax to set executable permissions) before running
-```
-bash setup.sh
-```
+**NOTE:** Only Python 3.8+ is supported.
 
-The **pyproject.toml** file contains project dependencies and can be updated to add more dependencies at any stage of the project by running `poetry add <packagename>`.
-Minimum Python version supported is 3.9.
+---
 
-The **.pre-commit-config.yaml** contains all the linters that runs before committing changes.
+## Features
+- Hooks: Pre-commit
+- Formatters and Linters: Black, Flake8, Flake8-bugbear, Isort, and Lizard
+- Testing Frameworks (Optional): Pytest, Coverage, and CovDefaults
+
+## Usage
+
+- Since this template uses Poetry as the dependancy manager, install poetry from `https://python-poetry.org/docs/#installation`
+
+- Install the `cookiecutter` library.
+
+    ```python
+    python -m pip install cookiecutter
+    ```
+
+- Run the command:
+    ```python
+    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
+   - Create a Poetry virtualenv
+   - Install all dependencies
+   - Install the pre-commit and pre-push hooks.

cookiecutter.json

@@ -0,0 +1,11 @@
+{
+    "full_name": "Gurashish Singh",
+    "email": "gurashish1singh@gmail.com",
+    "github_username": "gurashish1singh",
+    "project_name": "Boilerplate Template",
+    "github_repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
+    "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
+    "project_short_description": "Minimal python cookiecutter template with Poetry as the dependency manager and Black, Isort, Flake8, Flake8-bugbear as the linters.",
+    "version": "0.1.0",
+    "pytest": ["y", "n"]
+}

hooks/post_gen_project.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python
+from __future__ import annotations
+
+import shlex
+import subprocess
+import sys
+from pathlib import Path
+
+ERROR_MSG = "Error occured while running cmd"
+PRETTY_LINES = "*" * 80
+
+
+def main() -> int:
+    working_dir = Path().resolve()
+    git_dir = Path(working_dir, ".git")
+    ret_code_one = 0
+    if not git_dir.exists():
+        ret_code_one = initialize_git()
+
+    if ret_code_one == 0:
+        ret_code_two = setup_environment()
+    return ret_code_one or ret_code_two or 0
+
+
+def initialize_git() -> int:
+    COMMANDS_AND_MESSAGE = {
+        "default_branch": (
+            shlex.split("git config --global init.defaultBranch main"),
+            PRETTY_LINES,
+        ),
+        "init_git": (
+            shlex.split("git init"),
+            "Initializing an empty git repository\n",
+        ),
+    }
+    for cmds, message in COMMANDS_AND_MESSAGE.values():
+        print(message)
+        try:
+            subprocess.run(cmds, check=True)
+        except subprocess.CalledProcessError as e:
+            print(ERROR_MSG, e)
+            return e.returncode
+
+    return 0
+
+
+def setup_environment() -> int:
+
+    COMMANDS_AND_MESSAGE = {
+        "install_poetry": (
+            shlex.split("poetry install"),
+            f"\n{PRETTY_LINES}\nInstalling poetry virtual environment",
+        ),
+        "install_pre_commit": (
+            shlex.split(
+                "poetry run pre-commit install --hook-type pre-commit --hook-type pre-push"
+            ),
+            f"\n{PRETTY_LINES}\nInstalling pre-commit hooks",
+        ),
+    }
+    for cmds, message in COMMANDS_AND_MESSAGE.values():
+        print(message)
+        try:
+            subprocess.run(cmds, check=True)
+        except subprocess.CalledProcessError as e:
+            print(ERROR_MSG, e)
+            return e.returncode
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

poetry.lock

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

poetry.toml

@@ -1,19 +1,21 @@
 [tool.poetry]
-name = "PLACEHOLDER PROJECT NAME"
+name = "cookiecutter-python"
 version = "0.1.0"
-description = "PLACEHOLDER DESCRIPTION OF THE PROJECT"
+description = "A Python Cookiecutter template with Poetry as a dependency manager"
 authors = ["Gurashish Singh <gurashish1singh@gmail.com>"]
+readme = "README.md"
+license = "MIT"
 
 [tool.poetry.dependencies]
-python = "^3.9"
-PyYAML = "^6"
-python-json-logger = "^2"
+python = "^3.8"
 
 [tool.poetry.dev-dependencies]
 flake8 = "^5"
 isort = "^5.5"
 black = "^22.9"
 pre-commit = "^2.20"
+flake8-bugbear = "^22"
+lizard = "^1.17"
 
 [tool.black]
 line-length = 100

pyproject.toml

@@ -5,5 +5,8 @@ exclude =
     # There's no value in checking cache directories
     __pycache__,
     # Don't check virtualenv
-    venv/
+    venv/,
+    .venv/
 max_line_length = 100
+# B001 is already enabled for flake8-bugbear
+extend-ignore = E722