Merge pull request #76 from QA-Automation-Starter/10-template-module-implementation

10 template module implementation

Author: adrian-herscu

README.md

@@ -61,6 +61,7 @@ Open in Codespace or Dev Container and everything will get installed and configu
    pdm run install-all
    ```
    > NOTE: This must be run whenever new dependencies, or versions are changed.
+   > NOTE: in VSCode may need to reload the window in order to refresh
 
 3. Run all tests from the root:
    ```bash

cookiecutter.json

@@ -0,0 +1,8 @@
+{
+  "project_name": "My Project",
+  "project_slug": "my-project",
+  "package_name": "my_project",
+  "version": "0.0.1",
+  "description": "BDD automation project",
+  "author": "Your Name"
+}

docs/getting-started.md

@@ -9,7 +9,14 @@ Open in Codespace or Dev Container and everything will get installed and configu
    pipx install pdm[all]
    ```
 
-2. Fork/Clone [demo project](https://github.com/QA-Automation-Starter/qa-automation-python-demo), e.g.:
+2. Generate from template:
+   ```bash
+   cookiecutter gh:QA-Automation-Starter/qa-automation-python
+   ```
+   
+   or
+   
+   Fork/Clone [demo project](https://github.com/QA-Automation-Starter/qa-automation-python-demo), e.g.:
    ```bash
    git clone https://github.com/QA-Automation-Starter/qa-automation-python-demo.git
    ```

qa-pytest-template/README.md

@@ -0,0 +1,42 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Python environments
+.venv/
+
+# Distribution / packaging
+dist/
+.pdm-build
+.pdm-python
+.python-version
+
+# Installer logs
+
+# Unit test / coverage reports
+.pytest_cache/
+
+# Mypy
+
+# Pyre / Pytype
+
+# Ruff
+
+# Debugging & development
+*.log
+
+# Notebook / IPython
+
+# JupyterLite / Sphinx / docs
+
+# Cython
+
+# Other tools & IDEs
+
+# JetBrains / PyCharm (optional - uncomment to ignore everything)
+#.idea/
+
+# Miscellaneous
+allure-results
+report.html
+docs/reports/
+*.zip

{{cookiecutter.project_slug}}/.gitignore

@@ -0,0 +1,12 @@
+{
+    "recommendations": [
+        "alphabotsec.vscode-eclipse-keybindings",
+        "bierner.markdown-mermaid",
+        "ms-python.autopep8",
+        "ms-python.debugpy",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "spmeesseman.vscode-taskexplorer",
+        "tamasfe.even-better-toml",
+    ]
+}

{{cookiecutter.project_slug}}/.vscode/extensions.json

@@ -0,0 +1,34 @@
+{
+    "files.autoSave": "afterDelay",
+    "files.autoSaveDelay": 1000,
+    "python.defaultInterpreterPath": ".venv/bin/python",
+    "python.terminal.activateEnvironment": true,
+    "python.testing.pytestArgs": [
+        "-s",
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.analysis.autoImportCompletions": true,
+    "python.analysis.typeCheckingMode": "strict",
+    "python.analysis.diagnosticSeverityOverrides": {
+        "reportMissingTypeStubs": "none"
+    },
+    "python.analysis.indexing": true,
+    "python.analysis.completeFunctionParens": true,
+    "python.analysis.inlayHints.variableTypes": true,
+    "python.analysis.inlayHints.functionReturnTypes": true,
+    "editor.rulers": [80],
+    "editor.codeActionsOnSave": {
+        "source.organizeImports": "always",
+        "source.unusedImports": "always",
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.autopep8",
+        "editor.formatOnSave": true
+    },
+    "autopep8.args": [
+        "--max-line-length=80",
+        "--experimental"
+    ]
+}

{{cookiecutter.project_slug}}/.vscode/settings.json

@@ -0,0 +1,33 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "clean-all",
+      "type": "shell",
+      "command": "pdm run clean-all",
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "test-all",
+      "type": "shell",
+      "command": "pdm run test-all",
+      "group": "test",
+      "problemMatcher": ["$pytest"]
+    },
+    {
+      "label": "install-deps",
+      "type": "shell",
+      "command": "pdm run install-deps",
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "allure-generate",
+      "type": "shell",
+      "command": "pdm run allure-generate",
+      "group": "build",
+      "problemMatcher": []
+    }
+  ]
+}

{{cookiecutter.project_slug}}/.vscode/tasks.json

@@ -0,0 +1,15 @@
+# {{ cookiecutter.project_name }}
+
+{{ cookiecutter.description }}
+
+## Setup
+```bash
+pdm install
+```
+
+> NOTE: in VSCode you will need to reload the window in order to get tests recognized
+
+## Run tests
+```bash
+pdm run pytest
+```

{{cookiecutter.project_slug}}/README.md

@@ -0,0 +1,53 @@
+; SPDX-FileCopyrightText: 2025 Adrian Herscu
+;
+; SPDX-License-Identifier: Apache-2.0
+
+[handlers]
+; NOTE: each key here must have a handler_xxx section below
+keys=console,overwrite_file
+
+[handler_console]
+class=StreamHandler
+level=DEBUG
+formatter=time_level_thread_name_message
+args=(sys.stdout,)
+
+[handler_overwrite_file]
+class=FileHandler
+level=DEBUG
+formatter=time_level_thread_name_message
+args=('pytest.log', 'w')
+
+[formatters]
+; NOTE: each key here must have a formatter_xxx section below
+keys=time_level_thread_name_message
+
+[formatter_time_level_thread_name_message]
+format=%(asctime)s [%(levelname)-1.1s] [%(threadName)-10.10s]: %(name)-14.14s - %(message)s
+; NOTE don't need milliseconds meanwhile, otherwise append .%03d below
+datefmt=%H:%M:%S
+
+[loggers]
+keys=root,selenium,urllib3,WDM
+
+[logger_root]
+level=DEBUG
+handlers=console,overwrite_file
+
+[logger_selenium]
+level=WARNING
+handlers=console,overwrite_file
+qualname=selenium
+propagate=0
+
+[logger_urllib3]
+level=DEBUG
+handlers=console,overwrite_file
+qualname=urllib3
+propagate=0
+
+[logger_WDM]
+level=WARNING
+handlers=console,overwrite_file
+qualname=WDM
+propagate=0