Add pre-commit Support (#1)

* Add pre-commit

* Update devcontainer

* Update code naming convention

* Update pyproject

* Add random docs

Author: ross-tsenov

.devcontainer/Dockerfile

@@ -14,7 +14,7 @@ RUN apt-get install -y --no-install-recommends \
     make \
     git \
     wget \
-    curl 
+    curl
 
 RUN apt-get install -y --no-install-recommends \
     python3 \
@@ -35,11 +35,11 @@ FROM debian as poetry
 
 ENV PATH="/home/vscode/.local/bin:${PATH}"
 
-ARG PYTHON_VIRTUALENV_HOME=/home/vscode/${PROJECT_NAME}-py-env \
+ARG PYTHON_VIRTUALENV_HOME=/home/vscode/project-py-env \
     POETRY_VERSION=1.8.2
 
 ENV POETRY_VIRTUALENVS_IN_PROJECT=false \
-    POETRY_NO_INTERACTION=true 
+    POETRY_NO_INTERACTION=true
 
 RUN python3 -m venv ${PYTHON_VIRTUALENV_HOME} && \
     $PYTHON_VIRTUALENV_HOME/bin/pip install --upgrade pip wheel && \
@@ -56,8 +56,8 @@ FROM poetry as project-dev
 
 COPY --chown=vscode:vscode pyproject.toml poetry.lock* ./
 
-RUN poetry install --no-root --with dev
+RUN poetry install --no-root --with dev --with docs
 
 WORKDIR /workspaces/${PROJECT_NAME}
 
-CMD ["/bin/bash"]
+CMD ["/bin/bash"]

.devcontainer/devcontainer.json

@@ -5,11 +5,11 @@
     "context": "..",
     "dockerFile": "./Dockerfile",
     "runArgs": [
-		"--cpus=1.0",
-        "--memory=1g",
-        "--ipc=host",
-        "--privileged",
-        "--net=host"
+		// "--cpus=1.0",
+        // "--memory=1g",
+        // "--ipc=host",
+        // "--privileged",
+        // "--net=host"
     ],
     "mounts": [
 		// {
@@ -20,7 +20,7 @@
     ],
 	"customizations": {
 		"vscode": {
-			"extensions": [   
+			"extensions": [
 				"ms-python.python",
 				"ms-azuretools.vscode-docker",
 				"njpwerner.autodocstring",
@@ -37,10 +37,9 @@
 				"redhat.vscode-yaml"
 			],
 			"settings": {
-				"python.defaultInterpreterPath": "/home/vscode/python-project-template-py-env/bin/python"
+				"python.defaultInterpreterPath": "/home/vscode/project-py-env/bin/python"
 			}
 		}
-		
 	},
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
@@ -61,4 +60,4 @@
             "PROJECT_NAME": "python-project-template"
         }
     }
-}
+}

.env.sample

@@ -1,2 +1,2 @@
 ENV="dev"
-OTHER_VAR="OIHER VAR"
+OTHER_VAR="OIHER VAR"

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.3.0
+  hooks:
+  - id: no-commit-to-branch
+  - id: check-added-large-files
+  - id: check-yaml
+    args: ['--unsafe']
+  - id: check-toml
+  - id: check-ast
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+  - id: check-case-conflict
+  - id: check-docstring-first
+  - id: name-tests-test
+  - id: detect-private-key
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+    - id: codespell
+      entry: codespell
+      args:
+        [
+          "--ignore-words-list=py,",
+          "--quiet-level=2",
+          "--skip=./**/tests/**,./**/_test*.py,.git,*.ipynb,*.json,*.lock,*.txt,*.yaml",
+        ]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.3.3
+  hooks:
+    - id: ruff
+      types_or: [ python, pyi, jupyter ]
+      args: [ --fix ]
+    - id: ruff-format
+      types_or: [ python, pyi, jupyter ]
+
+- repo: local
+  hooks:
+    - id: mypy
+      name: check typing
+      description: ""
+      entry: mypy
+      language: python
+      types_or: [python, pyi]
+      args: ["--ignore-missing-imports"]
+      require_serial: true
+
+- repo: local
+  hooks:
+    - id: pytest
+      name: run tests
+      description: ""
+      entry: poetry run pytest tests
+      pass_filenames: false
+      language: python
+      types_or: [python, pyi]
+      args: []
+      require_serial: true

docs/getting_started/installation.md

@@ -1 +1 @@
-# Installation steps.
+# Installation steps.

docs/index.md

@@ -1 +1 @@
-# Introduction
+# Introduction

poetry.lock

@@ -4,15 +4,21 @@ version = "0.0.1"
 description = "Description."
 license = "MIT"
 authors = ["Author <[email protected]>"]
+maintainers = ["Author <[email protected]>"]
+repository = "https://github.com/ross-tsenov/python-project-template"
+documentation = "https://github.com/ross-tsenov/python-project-template/tree/main/docs/"
 readme = "README.md"
+include = [
+    "src",
+]
 exclude = [
     "docs/*",
     "tests/*",
 ]
 
 
 [tool.poetry.dependencies]
-python = ">=3.10.1,<4.0"
+python = "^3.10.1"
 python-dotenv = "^1.0.0"
 pydantic-settings = "^2.2.1"
 
@@ -21,7 +27,6 @@ pydantic-settings = "^2.2.1"
 ruff = "^0.0.285"
 mypy = "^1.8.0"
 pytest = "^7.4.4"
-pytest-cov = "^4.1.0"
 pre-commit = "^3.6.2"
 
 
@@ -44,14 +49,20 @@ line-length = 122
 target-version = "py310"
 # All options here: https://github.com/charliermarsh/ruff#supported-rules
 select = [
+    "A",
+    "B",
     "E",
-    "W",
     "F",
+    "G",
+    "I",
+    "N",
+    "W",
     "Q",
     "S",
     "UP",
-    "I",
-    "N",
+    "C9",
+    "PT",
+    "ANN",
     "PLC",
     "PLE",
     "PLR",
@@ -98,17 +109,24 @@ pretty = true
 follow_imports="silent"
 ignore_missing_imports = true
 show_error_codes = true
+exclude = [
+    "__init__.py",
+]
 
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "-ra -q"
+addopts = """
+-ra \
+-q \
+--verbose \
+--maxfail=1 \
+--color=yes """
 testpaths = ["tests/"]
+python_files = ["*_test.py"]
+python_functions = ["test_*"]
+render_collapsed = true
 filterwarnings = [
     "ignore",
     "default:::mymodule",
 ]
-
-
-[tool.coverage.paths]
-source = ["cendiant_inspection/"]

pyproject.toml

@@ -1,13 +1,18 @@
-from typing import Literal
+from enum import StrEnum
 
 from dotenv import load_dotenv
 from pydantic_settings import BaseSettings
 
 
+class Environment(StrEnum):
+    DEV = "dev"
+    PROD = "prod"
+
+
 class Settings(BaseSettings):
     """Global application settings loaded from the .env file."""
 
-    env: Literal["dev", "prod"] = "dev"
+    env: Environment = Environment.DEV
     other_var: str = "other"
 
 

python_project_template/__init__.py renamed to src/__init__.py

@@ -0,0 +1,5 @@
+from src.settings import Environment, settings
+
+
+def test_settings() -> None:
+    assert settings.env in [Environment.DEV, Environment.PROD]