Cybernetic-Ransomware · Cybernetic-Ransomware · Jul 1, 2026 · Jul 1, 2026 · Jul 1, 2026 · Jul 1, 2026
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,17 @@
+# Normalize text files to LF on checkout/checkin
+* text eol=lf
+
+# Binary files — prevent line ending conversion
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.ico binary
+
+# Extra explicit rules for common text file types
+*.py text eol=lf
+*.toml text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.lock text eol=lf
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,35 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python with uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: ruff format check
+        run: uv run ruff format --check app/
+
+      - name: ruff lint
+        run: uv run ruff check app/
+
+      - name: ty type check
+        run: uv run ty check
+
+      - name: codespell
+        run: uv run python -m codespell_lib app/
+
+      - name: bandit security scan
+        run: uv run bandit -q -c pyproject.toml -r app/
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 
 **/app.log
 *.pyc
+.ruff_cache/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,47 @@
+default_install_hook_types:
+  - pre-commit
+
+repos:
+  - repo: local
+    hooks:
+      - id: uv-lock-check
+        name: uv lock check
+        entry: uv lock --check
+        language: system
+        files: ^(pyproject\.toml|uv\.lock)$
+        pass_filenames: false
+
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format
+        language: system
+        types: [python]
+        files: ^app/
+
+      - id: ruff-check
+        name: ruff lint
+        entry: uv run ruff check --fix
+        language: system
+        types: [python]
+        files: ^app/
+
+      - id: ty-check
+        name: ty type checker
+        entry: uv run ty check
+        language: system
+        types: [python]
+        files: ^app/
+        pass_filenames: false
+
+      - id: codespell
+        name: codespell
+        entry: uv run python -m codespell_lib
+        language: system
+        types_or: [python, markdown, yaml, rst]
+
+      - id: bandit
+        name: bandit security scan
+        entry: uv run bandit -q -c pyproject.toml
+        language: system
+        types: [python]
+        files: ^app/
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/README.md b/README.md
@@ -4,33 +4,32 @@ Quick implementation of a database connector with both REST endpoints and GraphQ
 
 ---
 
+## Requirements
+
+| Tool   | Version                                       |
+|--------|-----------------------------------------------|
+| Python | >= 3.12                                       |
+| uv     | latest                                        |
+| just   | latest (optional, for the `justfile` recipes) |
+
 ## Initialization
 
 1. Clone the repository:
     ```bash
     git clone https://github.com/Cybernetic-Ransomware/template_GraphQL_SQLAlchemy_FastAPI.git
     ```
-2. Install Python >= 3.12.
-3. Create a virtual environment:
+2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
+3. Install dependencies (creates `.venv` and installs runtime + dev dependencies):
     ```bash
-    python -m venv .venv
+    uv sync
     ```
-4. Activate the virtual environment:
-    - On Windows:
-      ```bash
-      .venv\Scripts\activate
-      ```
-    - On macOS and Linux:
-      ```bash
-      source .venv/bin/activate
-      ```
-5. Install dependencies from `requirements.txt`:
+4. Run the application:
     ```bash
-    pip install -r requirements.txt
+    uv run uvicorn app.main:app --reload --port 8080
     ```
-6. Run the application:
+    or, with [just](https://github.com/casey/just):
     ```bash
-    uvicorn app.main:app --reload --port 8080
+    just run
     ```
 
 ---
@@ -42,6 +41,22 @@ Quick implementation of a database connector with both REST endpoints and GraphQ
 
 ---
 
+## Development
+
+Set up the pre-commit hooks once after cloning:
+```bash
+uv run pre-commit install
+```
+
+Common tasks (see `justfile` for the full list):
+```bash
+just format   # ruff format
+just lint     # ruff format + lint, ty type-check, codespell, bandit
+just commit   # run pre-commit, then open Commitizen for a conventional commit
+```
+
+---
+
 ## Useful links and documentation
 
 - SQLAlchemy: [https://docs.sqlalchemy.org/en/20/](https://docs.sqlalchemy.org/en/20/)

diff --git a/app/connector.py b/app/connector.py
@@ -1,5 +1,6 @@
 from sqlalchemy.future import select
 from sqlalchemy.orm import Session
+
 from app.models import Item
 from app.schemas import ItemCreate
 

diff --git a/app/db/database.py b/app/db/database.py
@@ -2,7 +2,6 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
 
-
 DATABASE_URL = "sqlite:///./test.db"
 
 

diff --git a/app/graphql/context.py b/app/graphql/context.py
@@ -1,10 +1,8 @@
 from fastapi import Depends
-
 from sqlalchemy.orm import Session
+
 from app.db.database import get_db
 
 
 async def get_context(db: Session = Depends(get_db)):
-    return {
-        "db": db
-    }
+    return {"db": db}
diff --git a/app/graphql/resolvers.py b/app/graphql/resolvers.py
@@ -1,14 +1,12 @@
 import asyncio
-import strawberry
-
-from typing import AsyncGenerator
+from collections.abc import AsyncGenerator
 
+import strawberry
 from sqlalchemy.orm import Session
 from strawberry.types import Info
 
-from app.connector import create_item, read_items, read_item
+from app.connector import create_item, read_item, read_items
 from app.schemas import ItemCreate
-from app.models import Item
 
 
 @strawberry.type
@@ -19,7 +17,6 @@ class ItemType:
 
 @strawberry.type
 class Query:
-
     @strawberry.field
     def hello(self) -> str:
         return "Hello World"

diff --git a/app/graphql/schema.py b/app/graphql/schema.py
@@ -1,6 +1,5 @@
 import strawberry
 
-from app.graphql.resolvers import Query, Mutation, Subscription
-
+from app.graphql.resolvers import Mutation, Query, Subscription
 
 schema = strawberry.Schema(query=Query, mutation=Mutation, subscription=Subscription)
diff --git a/app/logger/conf_log.py b/app/logger/conf_log.py
@@ -3,16 +3,16 @@
 
 def setup_logger():
     logging.basicConfig(
-        filename='app.log',  # Plik, do którego będą zapisywane logi
-        filemode='a',  # Tryb otwierania pliku (a - append)
-        format='%(asctime)s - %(levelname)s - %(message)s',  # Format logów
-        datefmt='%Y-%m-%d %H:%M:%S',  # Format daty i czasu
-        level=logging.INFO  # Poziom logowania
+        filename="app.log",  # File to which logs will be written
+        filemode="a",  # File open mode (a - append)
+        format="%(asctime)s - %(levelname)s - %(message)s",  # Log format
+        datefmt="%Y-%m-%d %H:%M:%S",  # Date and time format
+        level=logging.INFO,  # Logging level
     )
 
     console_handler = logging.StreamHandler()
     console_handler.setLevel(logging.ERROR)
-    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+    formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
     console_handler.setFormatter(formatter)
 
     logger = logging.getLogger()

diff --git a/app/main.py b/app/main.py
@@ -1,17 +1,15 @@
-from fastapi import FastAPI, Depends, HTTPException
+from fastapi import Depends, FastAPI, HTTPException
+from sqlalchemy.orm import Session
 from strawberry.fastapi import GraphQLRouter
 from strawberry.subscriptions import GRAPHQL_TRANSPORT_WS_PROTOCOL, GRAPHQL_WS_PROTOCOL
-from sqlalchemy.orm import Session
 
-
-from app.connector import create_item, read_items, read_item
-from app.db.database import engine, Base, get_db
+from app.connector import create_item, read_item, read_items
+from app.db.database import Base, engine, get_db
 from app.graphql.context import get_context
 from app.graphql.schema import schema
-from app.logger.conf_log import setup_logger, get_logger
+from app.logger.conf_log import get_logger, setup_logger
 from app.schemas import ItemCreate, ItemResponse
 
-
 setup_logger()
 logger = get_logger(__name__)
 

diff --git a/app/models.py b/app/models.py
@@ -1,4 +1,5 @@
 from sqlalchemy import Column, Integer, String
+
 from app.db.database import Base
 
 

diff --git a/justfile b/justfile
@@ -0,0 +1,30 @@
+# Install/sync all dependencies (runtime + dev)
+install:
+    uv sync
+
+# Apply ruff formatting to app source
+format:
+    uv run ruff format app/
+
+# Run the full linting suite: format, lint, type-check, spell-check, security scan
+lint:
+    uv run ruff format app/
+    uv run ruff check --fix app/
+    uv run ty check
+    uv run python -m codespell_lib app/
+    uv run bandit -q -c pyproject.toml -r app/
+
+# Run the app locally with auto-reload
+# Swagger UI: http://127.0.0.1:8080/docs
+# GraphQL Playground: http://127.0.0.1:8080/graphql
+run:
+    uv run uvicorn app.main:app --reload --port 8080
+
+# Run pre-commit on staged files, then open Commitizen
+commit:
+    uv run pre-commit run
+    uv run cz commit
+
+# Bump version (auto-tags vX.Y.Z, updates pyproject.toml)
+bump:
+    uv run cz bump
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,64 @@
+[project]
+name = "template-graphql-sqlalchemy-fastapi"
+version = "0.1.0"
+description = "Template Project: GraphQL (Strawberry) + SQLAlchemy + FastAPI"
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi[standard]>=0.138.2",
+    "pydantic>=2.13.4",
+    "sqlalchemy>=2.0.51",
+    "strawberry-graphql>=0.320.0",
+]
+
+[dependency-groups]
+dev = [
+    "bandit>=1.9.4",
+    "codespell>=2.4.2",
+    "commitizen>=4.16.4",
+    "pre-commit>=4.6.0",
+    "ruff>=0.15.20",
+    "ty>=0.0.55",
+]
+
+[tool.uv]
+package = false
+
+[tool.ruff]
+line-length = 124
+
+[tool.ruff.lint]
+select = ["E", "F", "UP", "B", "SIM", "I", "RUF"]
+ignore = []
+
+[tool.ruff.lint.flake8-bugbear]
+extend-immutable-calls = [
+    "fastapi.Depends",
+    "fastapi.params.Depends",
+    "fastapi.Query",
+    "fastapi.params.Query",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+docstring-code-line-length = 124
+
+[tool.ty.environment]
+python-version = "3.12"
+
+[tool.codespell]
+skip = "uv.lock,./.git,./.github"
+builtin = "clear"
+quiet-level = 3
+
+[tool.bandit]
+targets = ["app"]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "0.1.0"
+tag_format = "v$version"
+version_files = [
+    "pyproject.toml:version",
+]
diff --git a/requirements.txt b/requirements.txt
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,7 +2,6 @@
		from sqlalchemy.ext.declarative import declarative_base
		from sqlalchemy.orm import sessionmaker


		DATABASE_URL = "sqlite:///./test.db"


Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,5 @@
		from sqlalchemy import Column, Integer, String

		from app.db.database import Base


Expand Down