pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [ "setuptools>=77" ]

[project]
name = "holidays"
description = "Open World Holidays Framework"
readme = "README.md"
keywords = [ "calendar", "holidays", "l10n", "vacation", "worldwide" ]
license = "MIT"
license-files = [ "CONTRIBUTORS", "LICENSE" ]
maintainers = [
  { name = "Arkadii Yakovets" },
  { name = "Panpakorn Siripanich" },
  { name = "Serhii Murza" },
]
authors = [ { name = "Vacanza Team" } ]
requires-python = ">=3.10"
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "Intended Audience :: Education",
  "Intended Audience :: End Users/Desktop",
  "Intended Audience :: Financial and Insurance Industry",
  "Intended Audience :: Information Technology",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3 :: Only",
  "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.15",
  "Programming Language :: Python :: Implementation :: CPython",
  "Topic :: File Formats :: JSON",
  "Topic :: Office/Business :: Financial :: Accounting",
  "Topic :: Office/Business :: Financial :: Investment",
  "Topic :: Office/Business :: Scheduling",
  "Topic :: Software Development :: Libraries :: Python Modules",
]
dynamic = [ "version" ]
dependencies = [ "python-dateutil>=2.9.0.post0,<3" ]
urls.Changelog = "https://github.com/vacanza/holidays/releases/"
urls.Documentation = "https://holidays.readthedocs.io/en/latest/"
urls.Repository = "https://github.com/vacanza/holidays/"
scripts.holidays-ics = "holidays.generate_ics:main"

[dependency-groups]
dev = [
  "gitpython>=3.1.50,<4",
  "hijridate>=2.5,<3",
  "lingva>=5.0.6,<6",
  "pdfplumber>=0.11.8,<1",
  "pre-commit>=4.5,<5",
  "pygithub>=2.8.1,<3",
  "requests>=2.32.5,<3",
  "skyfield>=1.54,<2",
]
docs = [
  "markdown-include>=0.8.1,<1",
  "mkdocs-gen-files>=0.6,<1",
  "mkdocs-literate-nav>=0.6.2,<1",
  "mkdocstrings-python>=2.0.1,<3",
  "properdocs>=1.6.6,<2",
  "properdocs-theme-readthedocs>=1.6.5,<2",
]
build = [
  "polib>=1.2,<2",
]
ci = [
  "cyclonedx-bom>=7.3,<8",
  "pre-commit>=4.5,<5",
  "pre-commit-uv>=4.3,<5",
  "uv==0.12.3",
]
tests = [
  "coverage>=7.12,<8",
  "numpy>=2,<2.3; python_version<'3.11'",
  "numpy>=2.3,<2.5; python_version=='3.11'",
  "numpy>=2.5,<3; python_version>='3.12' and python_version<'3.15'",
  "numpy>=2.5.2,<3; python_version>='3.15'",
  "polib>=1.2,<2",
  "pygments>=2.20,<3",
  "pytest>=9.0.1,<10",
  "pytest-cov>=7,<8",
  "pytest-xdist>=3.8,<4",
]

[tool.setuptools]
packages.find.include = [ "holidays*" ]
dynamic.version = { file = "VERSION" }

[tool.ruff]
target-version = "py310"
line-length = 99
lint.select = [
  "B009",   # flake8-bugbear - Do not call `getattr(x, 'attr')`
  "C4",     # flake8-comprehensions
  "E",      # pycodestyle - Error
  "F",      # Pyflakes
  "FBT",    # flake8-boolean-trap
  "N",      # pep8-naming
  "PERF",   # perflint
  "PLE",    # Pylint - Error
  "RUF001", # Ambiguous Unicode character in a string literal
  "RUF002", # Ambiguous Unicode character in a docstring
  "RUF003", # Ambiguous Unicode character in a comment
  "RUF022", # Unsorted `__all__`
  "RUF100", # Unused `#noqa` directive
  "S",      # flake8-bandit
  "SIM",    # flake8-simplify
  "T",      # flake8-debugger & flake8-print
  "TC",     # flake8-type-checking
  "UP",     # pyupgrade
  "W",      # pycodestyle - Warning
]
lint.per-file-ignores."holidays/__init__.py" = [ "F403" ]
lint.per-file-ignores."holidays/calendars/__init__.py" = [ "F401" ]
lint.per-file-ignores."holidays/constants.py" = [ "F401" ]
lint.per-file-ignores."holidays/countries/__init__.py" = [ "F401" ]
lint.per-file-ignores."holidays/financial/__init__.py" = [ "F401" ]
lint.per-file-ignores."holidays/generate_ics.py" = [ "T201" ]
lint.per-file-ignores."holidays/groups/__init__.py" = [ "F401" ]
lint.per-file-ignores."holidays/holiday_base.py" = [ "FBT" ]
lint.per-file-ignores."holidays/ical.py" = [ "FBT" ]
lint.per-file-ignores."holidays/mixins/__init__.py" = [ "F401" ]
lint.per-file-ignores."holidays/registry.py" = [ "FBT" ]
lint.per-file-ignores."holidays/utils.py" = [ "FBT" ]
lint.per-file-ignores."scripts/archive_links.py" = [ "T201" ]
lint.per-file-ignores."scripts/calendar/mabims_generator.py" = [ "T201" ]
lint.per-file-ignores."scripts/generate_release_notes.py" = [ "T201" ]
lint.per-file-ignores."scripts/generate_site_assets.py" = [ "T201" ]
lint.per-file-ignores."scripts/generate_snapshots.py" = [ "T201" ]
lint.per-file-ignores."scripts/l10n/generate_mo_files.py" = [ "T201" ]
lint.per-file-ignores."scripts/l10n/generate_po_files.py" = [ "T201" ]
lint.per-file-ignores."scripts/l10n/l10n_helper.py" = [ "T201" ]
lint.per-file-ignores."scripts/normalize_text.py" = [ "RUF001", "T201" ]
lint.per-file-ignores."tests/common.py" = [ "N802" ]
lint.per-file-ignores."tests/test_holiday_base.py" = [ "S301" ]
lint.per-file-ignores."tests/test_ical.py" = [ "RUF001" ]
lint.allowed-confusables = [
  # Arabic, Armenian, Bengali, CJK, Cyrillic, Tongan, Turkish Script.
  "ʻ",  # Modifier Letter Turned Comma (U+02BB)
  "՝",  # Armenian Comma (U+055D)
  "（", # Fullwidth Left Parenthesis (U+FF08)
  "）", # Fullwidth Right Parenthesis (U+FF09)
  "，", # Fullwidth Comma (U+FF0C)
  "০", # Bengali Digit Zero (U+09E6)
  "৭", # Bengali Digit Seven (U+09ED)
  "а",  # Cyrillic Small Letter A (U+0430)
  "б",  # Cyrillic Small Letter Be (U+0431)
  "е",  # Cyrillic Small Letter Ie (U+0435)
  "г",  # Cyrillic Small Letter Ghe (U+0433)
  "ه",  # Arabic Letter Heh (U+0647)
  "ı",  # Latin Small Letter Dotless I (U+0131)
  "і",  # Cyrillic Small Letter Byelorussian-Ukrainian I (U+0456)
  "І",  # Cyrillic Capital Letter Byelorussian-Ukrainian I (U+0406)
  "К",  # Cyrillic Capital Letter Ka (U+041A)
  "х",  # Cyrillic Small Letter Ha (U+0445)
  "Х",  # Cyrillic Capital Letter Ha (U+0425)
  "М",  # Cyrillic Capital Letter Em (U+041C)
  "Н",  # Cyrillic Capital Letter En (U+041D)
  "о",  # Cyrillic Small Letter O (U+043E)
  "О",  # Cyrillic Capital Letter O (U+041E)
  "р",  # Cyrillic Small Letter Er (U+0440)
  "Р",  # Cyrillic Capital Letter Er (U+0420)
  "с",  # Cyrillic Small Letter Es (U+0441)
  "С",  # Cyrillic Capital Letter Es (U+0421)
  "Т",  # Cyrillic Capital Letter Te (U+0422)
  "у",  # Cyrillic Small Letter U (U+0443)
  "У",  # Cyrillic Capital Letter U (U+0423)
  "В",  # Cyrillic Capital Letter Ve (U+0412)
  "З",  # Cyrillic Capital Letter Ze (U+0417)
  "ا",  # Arabic Letter Alef (U+0627)
]
lint.flake8-errmsg.max-string-length = 99
lint.pyupgrade.keep-runtime-typing = true

[tool.isort]
profile = "black"
line_length = 99
multi_line_output = 3
no_inline_sort = true
known_first_party = [ "holidays", "tests" ]
skip = [ "docs" ]

[tool.pyproject-fmt]
max_supported_python = "3.15"

[tool.mypy]
overrides = [
  { module = "holidays.countries.*", disable_error_code = [ "override" ] },
  { module = "holidays.financial.*", disable_error_code = [ "override" ] },
  { module = "holidays.groups.*", disable_error_code = [ "attr-defined" ] },
]

[tool.pytest]
ini_options.testpaths = [ "tests" ]
ini_options.addopts = [
  "--cov-fail-under=100",
]
ini_options.filterwarnings = [
  "ignore::DeprecationWarning:holidays.deprecations.v1_incompatibility",
]

[tool.coverage]
run.branch = true
run.omit = [ "scripts/*", "tests/*" ]
report.exclude_also = [
  "^if TYPE_CHECKING:",
]