Merge pull request #3 from arionvlad/tooling/development-environment

Configure Python development tooling

Author: arionvlad

.github/workflows/python.yml

@@ -19,5 +19,9 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - run: python -m pip install --upgrade pip
-      - run: python -m pip install -e .[test]
-      - run: python -m pytest
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check .
+      - run: ruff format --check .
+      - run: mypy .
+      - run: pytest
+

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{  
+    "recommendations": ["ms-python.python", "ms-python.vscode-pylance", "charliermarsh.ruff"]
+}

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestArgs": ["tests"],
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.ruff": "explicit",
+      "source.organizeImports.ruff": "explicit"
+    }
+  }
+}

pyproject.toml

@@ -16,5 +16,31 @@ dependencies = []
 [project.urls]
 Repository = "https://github.com/arionvlad/python-apprentice"
 
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "pytest",
+    "ruff",
+]
+
 [tool.setuptools.packages.find]
-where = ["src"]
+where = ["src"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+files = ["src", "tests"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

src/python_apprentice/__init__.py

@@ -1,12 +1,5 @@
 """Python Apprentice package."""
 
-from __future__ import annotations
+from .greetings import greet
 
-
-def greet(name: str) -> str:
-    return f"Hello, {name}!"
-
-
-from .main import main
-
-__all__ = ["greet", "main"]
+__all__ = ["greet"]

src/python_apprentice/greetings.py

@@ -0,0 +1,2 @@
+def greet(name: str) -> str:
+    return f"Hello, {name}!"

src/python_apprentice/main.py

@@ -1,13 +1,7 @@
 """Application entrypoint."""
 
-from __future__ import annotations
-
-from . import greet
+from python_apprentice import greet
 
 
 def main() -> None:
-    print(greet("World"))
-
-
-if __name__ == "__main__":
-    main()
+    print(greet("world"))

tests/test_greeting.py

@@ -0,0 +1,5 @@
+from python_apprentice import greet
+
+
+def test_greet_returns_personalized_message() -> None:
+    assert greet("Vlad") == "Hello, Vlad!"