pyproject.toml

# pyproject.toml: unified Python project metadata and tool configuration file
# See PEP-518: https://www.python.org/dev/peps/pep-0518/


# --------------------------------------------------------------------------
# Project setup
# --------------------------------------------------------------------------
# Project Metadata
# Reference: https://www.python.org/dev/peps/pep-0621/
[project]
name = "code-with-teddy"
version = "1.0"
description = "Teddy's portfolio website."
readme = "README.md"
requires-python = ">=3.12"
classifiers = [
    "Framework :: FastAPI",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.12",
]
maintainers = [
    { name = "Theodore Williams", email = "theodore.f.williams@gmail.com" },
]
# Dependencies specified here should ideally not be pinned, unless
# recommended by the package itself. This follows best practices
# established by PyPA:
#   https://packaging.python.org/discussions/install-requires-vs-requirements/
dependencies = [
    # Aiocache: async cache library (temporarily stopped using because it broke html script nonce)
    "aiocache",
    # Alembic: SQLAlchemy migration tool
    "alembic",
    # Asyncpg: PostgreSQL database adapter
    "asyncpg",
    # Bcrypt: password hashing library
    "bcrypt",
    # BeautifulSoup: HTML parser
    "beautifulsoup4",
    # Bleach: HTML sanitizer
    "bleach",
    # Cryptography: cryptographic library
    "cryptography",
    # Email-validator: email validation library for Pydantic
    "email-validator",
    # FastAPI: web framework
    "fastapi",
    # Gunicorn: load balancer
    "gunicorn",
    # Itsdangerous: cryptographically signed tokens
    "itsdangerous",
    # Jinja-partials: Jinja2 template partials
    "jinja-partials",
    # Jinja2: templating engine
    "jinja2",
    # MailerSend: email sending service
    "mailersend",
    # Markdown: Markdown parser
    "markdown",
    # Micawber: oEmbed consumer
    "micawber",
    # Pillow: image processing library
    "pillow",
    # PsycoPG: PostgreSQL database adapter
    "psycopg[binary,pool]",
    # Pydantic: data modeling, validation and settings management
    "pydantic",
    # Pydantic-settings: Pydantic settings management
    "pydantic-settings",
    # Pygments: syntax highlighting library
    "pygments",
    # PyJWT: JSON Web tokens
    "pyjwt",
    # Pymdown-extensions: Markdown extensions
    "pymdown-extensions",
    # Python-mulitpart: multipart form data parser
    "python-multipart",
    # Pytz: timezone library
    "pytz",
    # Sentry-sdk: error tracking
    "sentry-sdk[fastapi,sqlalchemy]", # aiohttp, httpx (dev deps)
    # SQLAlchemy: database toolkit
    "sqlalchemy[asyncio]",
    # Typer: CLI toolkit (needed in prod for Alembic migrations)
    "typer[all]",
    # Uv: Python package manager
    "uv",
    # Uvicorn: ASGI server
    "uvicorn[standard]",
    # werkzeug: WSGI utility library (also useful utilities for our ASGI app)
    "werkzeug",
    # WTForms: web forms library
    "wtforms[email]",
]

[project.optional-dependencies]
dev = [
    # Aiohttp: async HTTP client/server
    "aiohttp",
    # Anyio: async library
    "anyio",
    # Black: code formatter (for blacken-docs)
    "black",
    # Docker: containerization tool
    "docker",
    # Faker: fake data generator
    "faker",
    # HTTPX: async HTTP client
    "httpx",
    # Pip-tools: dependency management
    "pip-tools",
    # Playwright: browser automation
    "playwright",
    # Pre-commit: git pre-commit hooks
    "pre-commit",
    # Pytest: testing framework
    "pytest",
    # Pytest-cov: coverage support for pytest
    "pytest-cov",
    # Pytest-mock: mock support for pytest
    "pytest-mock",
    # Pytest-playwright: Playwright support for pytest
    "pytest-playwright",
    # Pytest-rerunfailures: re-run failed tests
    "pytest-rerunfailures",
    # Pyyaml: YAML parser
    "pyyaml",
    # Requests: HTTP client
    "requests",
    # Rich: pretty terminal output
    "rich",
    # Ruff: fast all-in-one linter, written in Rust
    "ruff",
    # Setuptools: build system
    "setuptools",
    # SQLAlchemy-utils: utility functions for SQLAlchemy
    "sqlalchemy-utils",
    # Tenacity: retrying library
    "tenacity",
    # Ty: static type checker
    "ty",
    # Types-*: type stubs for external libraries
    "types-bleach",
    "types-markdown",
    "types-pyyaml",
    "types-pytz",
    "types-requests",
]

[project.urls]
source = "https://github.com/VerdantFox/code-with-teddy"
issues = "https://github.com/VerdantFox/code-with-teddy/issues"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"


# --------------------------------------------------------------------------
# Tool configurations
# --------------------------------------------------------------------------
# ------------------------------ Pytest ------------------------------------
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "--reruns 2"
filterwarnings = [
    # Ignore warnings from all sources so that we can ignore warnings from
    # external libraries that we can't control.
    "ignore",
    # Overwrite to error on warnings from our own code.
    "error:::tests",
    "error:::app",
    "error:::scripts",
]


# Coverage
[tool.coverage.run]
branch = true
concurrency = ["greenlet", "thread"]


[tool.coverage.report]
exclude_lines = [
    # Have to re-enable the standard pragma
    "pragma: no cover",
    "if __name__ == __main__:",
    "if TYPE_CHECKING:",
    "if typing.TYPE_CHECKING:",
    "def __repr__",
    "def __str__",
]
include = ["app/*", "scripts/*", "tests/*"]
skip_covered = true # Don't show fully covered files in the report


# ----------------------- Ty: type checker ---------------------------------
# Reference: https://docs.astral.sh/ty/reference/configuration/
[tool.ty.environment]
python = "./venv"
python-version = "3.12"


# Rules references: https://docs.astral.sh/ty/reference/rules/
# Most rules have a default value already ("error", "warn", "ignore")
# This overwrites some of those rules
[tool.ty.rules]
invalid-ignore-comment = "error"
possibly-unbound-attribute = "error"
possibly-unbound-import = "error"
redundant-cast = "error"
undefined-reveal = "error"
unknown-rule = "error"
unresolved-global = "error"
unsupported-base = "error"
division-by-zero = "error"
possibly-unresolved-reference = "error"
unused-ignore-comment = "error"


# ------------------------ Ruff: linter + formatter-------------------------
# Reference: https://docs.astral.sh/ruff/configuration/
[tool.ruff]
line-length = 100
target-version = "py312"


[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = "dynamic"


[tool.ruff.lint]
# Rules to run
# Reference: https://docs.astral.sh/ruff/rules/
select = [
    "A",     # flake8-builtins
    "ANN",   # flake8-annotations
    "ASYNC", # flake8-async
    "ARG",   # flake8-unused-arguments
    "B",     # flake8-bugbear
    "BLE",   # flake8-blind-except
    "C4",    # flake8-comprehensions
    "C90",   # mccabe (complexity)
    "COM",   # flake8-commas
    "D",     # pydocstyle
    "DTZ",   # flake8-datetimez
    "E",     # pycodestyle errors
    "EM",    # flake8-errmsg
    "ERA",   # eradicate
    "EXE",   # flake8-executable
    "F",     # pyflakes
    "FBT",   # flake8-boolean-trap
    "FLY",   # flynt
    # "FURB",  # Refurb (In preview)
    "G",   # flake8-logging-format
    "I",   # isort
    "ICN", # flake8-import-conventions
    "INP", # flake8-no-pep420
    "ISC", # flake8-implicit-str-concat
    # "LOG",   # flake8-logging (In preview)
    "N",    # pep8-naming
    "NPY",  # NumPy-specific rules
    "PERF", # Perflint
    "PD",   # pandas-vet
    "PGH",  # pygrep-hooks
    "PIE",  # flake8-pie
    "PL",   # pylint
    "PLC",  # pylint-convention
    "PLE",  # pylint-error
    "PLR",  # pylint-refactor
    "PLW",  # pylint-warning
    "PT",   # flake8-pytest-style
    "PTH",  # flake8-use-pathlib
    "Q",    # flake8-quotes
    "RET",  # flake8-return
    "RSE",  # flake8-raise
    "RUF",  # ruff-specific rules
    "S",    # flake8-bandit
    "SIM",  # flake8-simplify
    "SLF",  # flake8-self
    "T10",  # flake8-debugger
    "T20",  # flake8-print
    "TID",  # flake8-tidy-imports
    "TRY",  # tryceratops
    "UP",   # pyupgrade
    "W",    # pycodestyle warnings
    "YTT",  # flake8-2020
]
# Roles to ignore
ignore = [
    "A003",   # builtin-attribute-shadowing. Shadowing `id` in a model for instance.
    "ANN401", # No dynamically typed expressions (like "Any")
    "COM812", # Missing trailing comma (can cause ruff formatter conflicts)
    "D105",   # Missing docstring in magic method
    "D107",   # Missing docstring in __init__
    "D203",   # 1 blank line required before class docstring (conflicts with D211 - No blank lines allowed before class docstring)
    "D213",   # Multi-line docstring summary should start at the second line (conflicts with D212 - Multi-line docstring summary should start at the first line)
    "ISC001", # Implicit string concatenation found (can cause ruff formatter conflicts)
]
# Don't automatically fix these errors, but still report them
unfixable = [
    "ERA001", # eradicate commented out code
    "T20",    # flake8-print
    "RUF100", # unused-noqa
]


[tool.ruff.lint.per-file-ignores]
"**/__init__.py" = ["D104"] # Missing docstring in public package
"scripts/*" = [
    "FBT003", # boolean-positional-value-in-call (needed for typer default arg)
    "S101",   # use of assert
    "S311",   # random-not-for-cryptography
    "T201",   # 'print' found
]
"scripts/alembic.py" = ["S603"] # subprocess-without-shell-equals-true
"migrations/versions/*" = ["D103"] # Missing docstring in public function
"tests/*" = [
    "ANN002",  # Missing type annotation for *args
    "ANN003",  # Missing type annotation for **kwargs
    "ANN201",  # Missing return type annotation for function
    "E501",    # line-too-long
    "PLR2004", # Magic value comparison
    "S101",    # assert-used
    "S105",    # Passwords should not be hard-coded
]


[tool.ruff.lint.mccabe]
max-complexity = 8


[tool.ruff.lint.isort]
known-first-party = ["app", "tests", "scripts"]