pyproject.toml

[project]
name = "fastapi-pagination"
version = "0.16.1"
description = "FastAPI pagination"
authors = [
    { name = "Yurii Karabas", email = "1998uriyyo@gmail.com" },
]
requires-python = ">=3.10"
readme = "README.md"
license = "MIT"
classifiers = [
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: 3 :: Only",
]
dependencies = [
    "fastapi>=0.140.13",
    "pydantic>=2.13.4",
    "typing-extensions>=4.8.0",
]

[project.optional-dependencies]
sqlmodel = [
    "sqlmodel>=0.0.22",
    "sqlakeyset>=2.0.1680321678",
]
sqlalchemy = [
    "SQLAlchemy>=1.3.20",
    "sqlakeyset>=2.0.1680321678",
]
ormar = ["ormar>=0.21.0"]
tortoise = ["tortoise-orm>=0.22.0"]
asyncpg = [
    "SQLAlchemy>=1.3.20",
    "asyncpg>=0.24.0",
]
django = ["django<6.0.0"]
piccolo = ["piccolo>=1.0"]
mongoengine = ["mongoengine>=0.23.1"]
beanie = ["beanie>=2.1.0"]
scylla-driver = ["scylla-driver>=3.25.6"]
elasticsearch = ["elasticsearch>=8.18.0"]
firestore = ["google-cloud-firestore>=2.19.0"]
aiosqlite = ["aiosqlite>=0.19.0,!=0.22.0,!=0.22.1"]
psycopg = ["psycopg[binary]>=3.3.2"]
peewee = ["peewee>=4.0", "greenlet", "aiosqlite>=0.19.0,!=0.22.0,!=0.22.1"]
peewee-sync = ["peewee>=4.0"]

[project.urls]
Repository = "https://github.com/uriyyo/fastapi-pagination"

[dependency-groups]
dev = [
    "pytest>=8.3.4",
    "pytest-cov>=6.0.0",
    "pytest-asyncio>=0.25.3",
    "flaky>=3.8.1",
    "pre-commit>=4.1.0",
    "Faker>=35.2",
    "psycopg2-binary>=2.9.10",
    "mkdocs>=1.6.1",
    "mkdocs-material>=9.5.50",
    "pymdown-extensions>=10.14,<13.0",
    "fontawesome-markdown>=0.2.6",
    "httpx>=0.28.1",
    "asgi-lifespan>=2.1.0",
    "requests>=2.32.2",
    "uvicorn>=0.34.0",
    "Jinja2>=3.1.5",
    "ruff>=0.14.0",
    "dirty-equals>=0.9.0",
    "ty>=0.0.11",
]
docs = [
    "mkdocs>=1.6.1",
    "mkdocs-material>=9.5.50",
    "pymdown-extensions>=10.14,<13.0",
    "fontawesome-markdown>=0.2.6",
    "mdx-include",
]

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

[tool.ruff]
line-length = 120
target-version = "py310"

[tool.ruff.lint]
select = [
    "ALL",  # select all checks by default
]
ignore = [
    # single rule exclude
    "ASYNC240", # allow async functions to use pathlib.Path methods
    "B008",    # do not perform function calls in argument defaults
    "S101",    # use of assert detected
    "SIM114",  # allow have multiple ifs with same body
    "TRY003",  # allow long exc message
    "RUF100",  # allow unused noqa
    "RUF012",  # allow mutable class var
    "COM812",  # will be handled by ruff format
    "ISC001",  # will be handled by ruff format
    "SLF001",  # allow access to private member
    "N806",    # allow variable name to start from uppercase letter
    "N805",    # ignore first argument name check
    "N818",    # ignore exception name should ends with Error suffix
    "FAST002", # allow to use non-annotated dependencies
    "PLR0913", # allow more than 5 arguments
    "PLR2004", # allow to compare with "magic numbers"
    "PLR0917", # allow too many positional arguments
    "PLW0108", # allow lambda with unnecessary function call
    "TC001",   # ignore moving things to if TYPE_CHECKING block
    "TC002",   # ignore moving things to if TYPE_CHECKING block
    "TC003",   # ignore moving things to if TYPE_CHECKING block
    "A005",    # allow module name to shadow a Python standard-library module
    "TC006",   # ignore quotes in typing.cast calls
    "PLC0415", # allow to have local imports
    "CPY001",  # ignore copyright

    # full rule exclude
    "D",    # ignore docstrings
    "FA",  # ignore future annotations
    "ANN", # ignore annotations
    "FIX", # ignore FIXMEs
    "TD",  # ignore all TODOs
    "ARG", # ignore unused arguments
    "FBT", # ignore flake8-boolean-trap
    "EM",  # ignore error message formatting
]
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
    ".venv",
]
per-file-ignores = { }
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

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

[tool.ty.src]
exclude = [
    "fastapi_pagination/ext/ormar.py",
    "fastapi_pagination/ext/peewee.py",
]

[tool.coverage.paths]
source = ["fastapi_pagination"]

[tool.coverage.run]
source = ["fastapi_pagination"]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "@abstractmethod",
    "@overload",
    "if TYPE_CHECKING:",
]