pyproject.toml

[project]
name = "vietnam-provinces"
description = "Library to provide list of Vietnam administrative divisions (tỉnh thành, quận huyện, phường xã)."
authors = [
    {name = "Nguyễn Hồng Quân", email = "ng.hong.quan@gmail.com"},
]
license = {text = "GPL-3.0-or-later"}
requires-python = "<4.0,>=3.10"
dynamic = ["version"]
dependencies = [
    "Unidecode<2.0.0,>=1.3.8",
    "fastenumplus>=1.4.0",
]
readme = "README.rst"
keywords = [
    "Vietnam",
    "administrative",
    "division",
    "locality",
]
classifiers = [
    "Natural Language :: Vietnamese",
    "Intended Audience :: Information Technology",
    "Intended Audience :: Financial and Insurance Industry",
    "Intended Audience :: Telecommunications Industry",
    "Operating System :: OS Independent",
    "Topic :: Software Development :: Localization",
    "Programming Language :: Python :: 3 :: Only",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
]

[project.urls]
repository = "https://github.com/sunshine-tech/VietnamProvinces.git"

[dependency-groups]
dev = [
    "pytest<9.0.0,>=8.3.4",
    "devtools<1.0.0,>=0.12.2",
    "python-rapidjson<2.0,>=1.20",
    "click<9.0.0,>=8.1.8",
    "pydantic<3.0.0,>=2.10.4",
    "logbook<2.0.0,>=1.8.0",
    "httpx<1.0.0,>=0.28.1",
    "mypy>=1.14.1",
]
lint = [
    "ruff<1.0.0,>=0.8.5",
]

[tool.ruff]
# Assume Python 3.12.
target-version = "py312"
line-length = 120
# Exclude a variety of commonly ignored directories.
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",
]

[tool.ruff.lint]
# Enable Pyflakes `E` and `F` codes by default.
select = ["E", "F"]
ignore = []
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.lint.per-file-ignores]
"vietnam_provinces/__init__.py" = ["F401"]

[tool.ruff.format]
quote-style = "single"

[tool.mypy]
python_version = "3.12"
plugins = [
  "pydantic.mypy",
]
# These options are recommended by Pydantic.
follow_imports = "silent"
warn_redundant_casts = true
warn_unused_ignores = true
disallow_any_generics = true
exclude = [
  '_enum_\w+\.py'
]
disable_error_code = 'prop-decorator'

[[tool.mypy.overrides]]
module = [
  "fast_enum",
  "logbook.*"
]
ignore_missing_imports = true

[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true

[build-system]
requires = ["flit_core >= 3.4"]
build-backend = "flit_core.buildapi"