initail setup

Author: sathishk

.gitignore

@@ -0,0 +1,42 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environment
+venv/
+.venv/
+
+# Environment variables
+.env
+.env.*
+!.env.example # Keep the example file
+
+# Unit test / coverage reports
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Static analysis cache
+.mypy_cache/
+.flake8
+.isort.cfg
+.black.cfg
+
+# Distribution / packaging
+/dist/
+/build/
+*.egg-info/
+.installed.cfg
+*.egg
+/docs/_build/
+
+# IDE-specific files (remove the ones you don't use)
+# PyCharm
+.idea/
+# VS Code
+.vscode/
+
+# Operating System files
+.DS_Store
+Thumbs.db

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.0 # Use the latest version
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-bugbear] # optional flake8 plugin
+  - repo: https://github.com/psf/black
+    rev: 24.4.2 # Use the latest version
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2 # Use the latest version
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.1 # Use the latest version
+    hooks:
+      - id: mypy

README.md

@@ -1,3 +1,3 @@
-# python-ref
+# Python Reference Project
 
 This project serves as a starter template for building python based projects.

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.flake8]
+# Ignores commonly addressed style issues handled by Black and isort
+ignore = ["E203", "E501", "W503"]
+max-line-length = 88
+
+[tool.isort]
+profile = "black" # Use settings compatible with the Black formatter
+
+[tool.black]
+line-length = 88 # Match the line length setting in Flake8
+
+[tool.mypy]
+# Excludes the virtual environment directory from mypy checks
+exclude = ["venv/*"]
+# Additional mypy configuration can go here. For example:
+# disallow_untyped_defs = true
+
+[tool.check]
+command = "isort src/ && black src/ && flake8 src/ && mypy src/"

requirements.txt

@@ -0,0 +1,29 @@
+autopep8==2.3.2
+black==25.9.0
+cfgv==3.4.0
+click==8.1.8
+distlib==0.4.0
+exceptiongroup==1.3.0
+filelock==3.19.1
+flake8==7.3.0
+identify==2.6.14
+iniconfig==2.1.0
+isort==6.0.1
+mccabe==0.7.0
+mypy==1.18.2
+mypy_extensions==1.1.0
+nodeenv==1.9.1
+packaging==25.0
+pathspec==0.12.1
+platformdirs==4.4.0
+pluggy==1.6.0
+pre_commit==4.3.0
+pycodestyle==2.14.0
+pyflakes==3.4.0
+Pygments==2.19.2
+pytest==8.4.2
+pytokens==0.1.10
+PyYAML==6.0.3
+tomli==2.2.1
+typing_extensions==4.15.0
+virtualenv==20.34.0

src/main.py

@@ -0,0 +1,7 @@
+# src/main.py
+def greet(name):
+    return f"Hello, {name}!"
+
+
+if __name__ == "__main__":
+    print(greet("World"))

test_main.py

@@ -0,0 +1,14 @@
+# test_main.py
+from src.main import greet
+
+
+def test_greet_world():
+    assert greet("World") == "Hello, World!"
+
+
+def test_greet_name():
+    assert greet("Alice") == "Hello, Alice!"
+
+
+def test_greet_empty_string():
+    assert greet("") == "Hello, !"