pyproject.toml

# SPDX-FileCopyrightText: 2026 calendaring-jmap contributors
# SPDX-License-Identifier: AGPL-3.0-or-later

[build-system]
requires = ["hatchling>=1.32.0", "hatch-vcs>=0.5.0"]
build-backend = "hatchling.build"

[project]
name = "calendaring-jmap"
description = "JMAP (RFC 8620) calendar client library"
readme = "README.md"
requires-python = ">=3.10"
license = "AGPL-3.0-or-later"
license-files = ["LICENSE"]
authors = [{ name = "Sashank Bhamidi" }]
dynamic = ["version"]
keywords = ["calendar", "calendaring", "jmap", "rfc8620", "ical", "icalendar"]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Topic :: Office/Business :: Scheduling",
  "Topic :: Software Development :: Libraries :: Python Modules",
]

dependencies = [
  "niquests>=3.21.1",
  "icalendar>=7.3.0",
  "PyYAML>=6.0.3",
]

[project.optional-dependencies]
async = ["niquests[asyncio]"]
requests = ["requests>=2.34.2"]
dev = [
  "pytest==9.1.1",
  "pytest-asyncio==1.4.0",
  "ruff==0.16.6",
  "mypy==1.18.2",
  "types-PyYAML==6.0.12.20260906",
  "types-requests==2.33.0.20260906",
  "requests>=2.34.2",
  "coverage==7.16.0",
  "pytest-cov==7.1.0",
  "towncrier==26.9.0",
]
docs = [
  "sphinx==9.1.0",
  "pydata-sphinx-theme==0.21.0",
  "sphinx-autobuild==2025.8.25",
  "sphinx-copybutton==0.5.2",
  "sphinx-design==0.7.0",
  "sphinx-issues==6.0.0",
  "sphinx-notfound-page==1.1.0",
]

[project.urls]
Repository = "https://github.com/pycalendar/calendaring-jmap"
Issues = "https://github.com/pycalendar/calendaring-jmap/issues"
Documentation = "https://calendaring-jmap.readthedocs.io/en/stable/"
Changelog = "https://calendaring-jmap.readthedocs.io/en/stable/reference/changelog.html"

[tool.hatch.version]
source = "vcs"

[tool.hatch.build.hooks.vcs]
version-file = "src/calendaring_jmap/_version.py"

[tool.hatch.build]
# Excludes dotfiles and top-level files with an extension by default, so a new
# local-only file at the repo root (an editor config, a local notes file) does
# not silently end up in the sdist just because it is not in .gitignore.
exclude = [
  "/.*",
  "/*.*",
  "/dist",
  "/build",
]

[tool.hatch.build.targets.wheel]
packages = ["src/calendaring_jmap"]

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

[tool.ruff.lint]
select = ["E", "F", "W", "I", "UP", "B"]

[tool.ruff.lint.per-file-ignores]
# AsyncSession is resolved before the rest of the module's imports so a
# missing niquests install fails fast with a clear error, not an opaque
# one from deep in the import chain.
"src/calendaring_jmap/async_client.py" = ["E402"]
# Imports are grouped by test class throughout this file, close to the
# tests that use them, rather than all hoisted to the top. The file is
# large enough that locality helps more than strict import ordering.
"src/calendaring_jmap/tests/test_jmap_unit.py" = ["E402"]

[tool.ruff.lint.isort]
known-first-party = ["calendaring_jmap"]

[tool.pytest.ini_options]
asyncio_mode = "strict"
testpaths = ["src/calendaring_jmap/tests"]

[tool.towncrier]
directory = "news/"
filename = "CHANGES.rst"
issue_format = "`#{issue} <https://github.com/pycalendar/calendaring-jmap/issues/{issue}>`_"
start_string = ".. towncrier release notes start\n"
title_format = "{version} ({project_date})"
underlines = ["-", "~", "`"]

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking changes"
showcontent = true

[[tool.towncrier.type]]
directory = "removal"
name = "Removals and deprecations"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "New features"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug fixes"
showcontent = true

[[tool.towncrier.type]]
directory = "documentation"
name = "Documentation"
showcontent = true

[[tool.towncrier.type]]
directory = "deps"
name = "Dependency changes"
showcontent = true

[[tool.towncrier.type]]
directory = "internal"
name = "Internal changes"
showcontent = true

[[tool.towncrier.type]]
directory = "chore"
name = "Other tasks"
showcontent = true

[[tool.towncrier.type]]
directory = "security"
name = "Security fixes"
showcontent = true