feat!: migrate API response keys to camelCase and mark v3.0.0 release by aditeyabaral · Pull Request #151 · pesu-dev/auth · GitHub

This pull request introduces several significant improvements to the codebase, focusing on modernizing the Python environment, updating dependencies and tooling, standardizing API field naming to camelCase, and enhancing documentation and workflow automation. The changes ensure better consistency, improved developer experience, and alignment with current best practices.

Key changes:

Python version and dependency management updates:

Raised the minimum required Python version to 3.12 across documentation, workflows, and the Dockerfile, and added support for Python 3.14 in CI. Switched to using the uv tool for dependency management and virtual environment creation throughout the project. [1] [2] [3] [4] [5]
Updated the Docker build process to use a multi-stage build with uv and Python 3.14, improving image size and reproducibility.

Pre-commit, linting, and workflow enhancements:

Updated pre-commit configuration to use ruff-check and mdformat, removed blacken-docs and pyupgrade, and added new formatting checks such as check-added-large-files. Updated pre-commit workflow to use uv for installing and running hooks. [1] [2] [3]
Updated the list of enforced checks and development instructions in .github/CONTRIBUTING.md to reflect these changes. [1] [2] [3]

API field naming and serialization improvements:

Standardized API request and response fields to camelCase (e.g., knowYourClassAndSection, campusCode, instituteName) in the models, documentation, and usage examples. Updated the KYCASModel to use an alias generator for camelCase, and ensured output serialization uses these aliases. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

General codebase modernization:

Replaced pytz with the standard library's zoneinfo for timezone handling in app/app.py.
Dynamically set the FastAPI app version using the package version from metadata.

Documentation and template improvements:

Updated documentation, API examples, and pull request templates to reflect the new field naming conventions and script locations. [1] [2] [3] [4] [5] [6]

These updates collectively modernize the project's tooling, improve consistency and clarity in the API, and streamline the developer workflow.

Replaces pip + requirements.txt with uv multi-stage build: - builder: ghcr.io/astral-sh/uv:python3.12-bookworm-slim - runtime: python:3.12-slim-bookworm (no uv in final image) - UV_COMPILE_BYTECODE=1 for faster startup - UV_LINK_MODE=copy for cross-stage compatibility - uv.lock as source of truth Image size: 285 MB (pip) → 231 MB (uv multi-stage), 54 MB reduction

… scripts - lint and pre-commit CI: remove multi-version matrix, pin to Python 3.12 (ruff and pre-commit hooks don't require multi-version runs) - scripts/benchmark/util.py: add know_your_class_and_section param to make_request - scripts/benchmark/benchmark_requests.py: add --know-your-class-and-section flag

ZoneInfo (Python 3.9+) is a drop-in replacement for pytz.timezone(). Removes pytz as a runtime dependency.

[dependency-groups] (PEP 735) is the correct home for dev-only tools that are never published as package extras. Updates pre-commit CI to install via uv sync instead of pip install .[dev].

…correct script paths

- Upgrade Dockerfile base images from python3.12 to python3.14 - Update ruff target-version from py312 to py314 - Fix ruff pre-commit hook id from legacy alias `ruff` to `ruff-check` - Fix stale Python 3.11 references in README to 3.12 (matching requires-python)

Reduces image size from ~150MB to ~117MB. Both builder and runtime use Alpine to ensure musl-compatible wheels are installed for compiled extensions (pydantic-core, selectolax).

Move AsyncIterator and Request to TYPE_CHECKING in app.py (annotation-only uses); add from __future__ import annotations to keep them lazy on Python <3.14. Configure runtime-evaluated-base-classes for pydantic.BaseModel to suppress false positives in Pydantic model files where field types must remain available at runtime.

Pull request overview

This PR delivers a breaking v3.0.0 update that standardizes the FastAPI /authenticate API contract to camelCase keys, modernizes the runtime/tooling (Python 3.12+, uv), and adjusts Docker/CI/docs/tests to match.

Changes:

Migrated request/response models to camelCase serialization via Pydantic alias_generator=to_camel, updated app logic to emit camelCase keys, and tightened request validation (extra="forbid").
Upgraded project metadata/tooling: Python >=3.12, version bump to 3.0.0, uv-based dependency management, and refreshed CI/pre-commit configuration.
Updated Docker build to a multi-stage uv flow and adjusted benchmarks/docs/tests to reflect the new API surface.

Reviewed changes

Copilot reviewed 22 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
app/app.py	Uses ZoneInfo and switches response dumping to camelCase aliases; app version now pulled from package metadata.
app/pesu.py	Updates default field names and response payload keys (e.g., campusCode, knowYourClassAndSection).
app/models/request.py	Enforces camelCase request aliases and forbids unknown request fields.
app/models/response.py	Enables camelCase aliases for response serialization.
app/models/profile.py	Enables camelCase aliases for profile serialization.
app/models/kycas.py	Enables camelCase aliases for KYCAS serialization.
app/docs/authenticate.py	Updates OpenAPI examples to camelCase keys.
Dockerfile	Moves to uv-based builder image and Python 3.14 Alpine runtime.
pyproject.toml	Bumps version to 3.0.0, Python to >=3.12, and adopts uv dependency groups.
requirements.txt	Regenerated lock output for updated dependency set.
README.md	Updates setup instructions and API docs/examples to camelCase and Python 3.12+.
.github/CONTRIBUTING.md	Updates contributor setup to Python 3.12+ and uv workflows.
.github/workflows/pre-commit.yaml	Uses uv sync --all-groups and updates Python matrix.
.github/workflows/lint.yaml	Updates Python matrix to 3.12–3.14.
.pre-commit-config.yaml	Updates ruff hook configuration and adds markdown formatting/size checks.
.github/PULL_REQUEST_TEMPLATE.md	Updates benchmark script paths referenced by the template.
scripts/benchmark/util.py	Adds KYCAS flag support and sends camelCase request key.
scripts/benchmark/benchmark_requests.py	Adds CLI flag to include KYCAS in benchmark requests.
tests/unit/test_request_model.py	Updates request validation tests for camelCase + forbidding deprecated keys.
tests/unit/test_pesu.py	Updates response assertions for camelCase keys and adds CSRF client lifecycle test.
tests/unit/test_app_unit.py	Adds unit test for CSRF refresh loop error logging.
tests/integration/test_app_integration.py	Updates integration assertions for camelCase and adds deprecated/extra key rejection coverage.
tests/functional/test_authenticate_functional.py	Updates functional assertions for camelCase response keys.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…ields Define ProfileField as a Literal type alias in pesu.py and derive DEFAULT_FIELDS from it via get_args(). Replace Literal[*PESUAcademy.DEFAULT_FIELDS] in RequestModel with list[ProfileField], removing the PESUAcademy import from the model entirely.

aditeyabaral added 2 commits May 21, 2026 23:02

rewrite: replace snake case keys with camel case

264fdb3

add: tests for new behavior

0a1628b

aditeyabaral requested a review from a team as a code owner May 22, 2026 03:30

aditeyabaral added 13 commits May 21, 2026 23:42

chore: upgrade target versions to python 3.14

4eba6d7

update: tests

83a387d

chore: bump version

dcbdfe0

feat: read app version from pyproject.toml

cfe81f1

fix: Dockerfile

47b69f6

chore: update uv.lock with Python 3.14 resolution markers

e71903d

chore: restore Python version matrix for lint and pre-commit CI

c2d3cb1

chore: replace pytz with stdlib zoneinfo

2c092fd

ZoneInfo (Python 3.9+) is a drop-in replacement for pytz.timezone(). Removes pytz as a runtime dependency.

chore: upgrade all dependencies to latest versions

482ca2d

chore: bump minimum version bounds in pyproject.toml to current latest

f20659d

chore: migrate dev deps from optional-dependencies to dependency-groups

fa36704

[dependency-groups] (PEP 735) is the correct home for dev-only tools that are never published as package extras. Updates pre-commit CI to install via uv sync instead of pip install .[dev].

aditeyabaral mentioned this pull request May 23, 2026

Remove redundant dependencies, update versions and modernize Dockerfile #149

Closed

36 tasks

aditeyabaral added 3 commits May 22, 2026 21:22

fix: run pre-commit via uv run to use venv PATH

f77f84f

fix: install all dependency groups in pre-commit CI

92279a2

docs: update .github docs for Python 3.12, uv dependency-groups, and …

d3ef90f

…correct script paths

aditeyabaral changed the title [BREAKING] Replace snake_case keys with camelCase feat!: migrate API response keys to camelCase and mark v3.0.0 release May 23, 2026

aditeyabaral self-assigned this May 23, 2026

aditeyabaral requested review from achyu-dev and ndigvijay May 23, 2026 01:31

achyu-dev requested changes May 23, 2026

View reviewed changes

Comment thread .github/CONTRIBUTING.md

Comment thread app/docs/authenticate.py

Comment thread app/app.py

Comment thread tests/functional/test_authenticate_functional.py

Comment thread tests/integration/test_app_integration.py

Comment thread tests/unit/test_request_model.py

aditeyabaral added 4 commits May 23, 2026 20:18

chore: minor string update

02ecc26

chore: switch Docker base images to python3.14-alpine

7b10344

Reduces image size from ~150MB to ~117MB. Both builder and runtime use Alpine to ensure musl-compatible wheels are installed for compiled extensions (pydantic-core, selectolax).

aditeyabaral requested a review from Copilot May 24, 2026 03:20

Copilot started reviewing on behalf of aditeyabaral May 24, 2026 03:20 View session

Copilot AI reviewed May 24, 2026

View reviewed changes

Comment thread Dockerfile

Comment thread app/app.py

achyu-dev approved these changes May 24, 2026

View reviewed changes

aditeyabaral merged commit 4e14e18 into pesu-dev:dev May 24, 2026
8 checks passed

feat!: migrate API response keys to camelCase and mark v3.0.0 release by aditeyabaral · Pull Request #151 · pesu-dev/auth · GitHub

Uh oh!

feat!: migrate API response keys to camelCase and mark v3.0.0 release - #151

feat!: migrate API response keys to camelCase and mark v3.0.0 release#151
aditeyabaral merged 23 commits into
pesu-dev:devfrom
aditeyabaral:refactor/camelCase-field-names

aditeyabaral commented May 22, 2026 •
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat!: migrate API response keys to camelCase and mark v3.0.0 release by aditeyabaral · Pull Request #151 · pesu-dev/auth · GitHub

Uh oh!

feat!: migrate API response keys to camelCase and mark v3.0.0 release - #151

feat!: migrate API response keys to camelCase and mark v3.0.0 release#151aditeyabaral merged 23 commits intopesu-dev:devpesu-dev/auth:devfrom aditeyabaral:refactor/camelCase-field-namesaditeyabaral/auth:refactor/camelCase-field-namesCopy head branch name to clipboard

Conversation

aditeyabaral commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat!: migrate API response keys to camelCase and mark v3.0.0 release#151
aditeyabaral merged 23 commits into
pesu-dev:devfrom
aditeyabaral:refactor/camelCase-field-names

aditeyabaral commented May 22, 2026 •
edited
Loading