pyproject.toml

[project]
name = "humid"
version = "0.3.1"
description = "Human Friendly UUIDs that are readable and pronounceable."
authors = [{ name = "W. Meijer", email = "houterm+humid@gmail.com" }]
requires-python = ">=3.9"
readme = "README.md"
license = { text = "MIT" }
keywords = [
    "UUID",
    "ID",
    "identifier",
    "unique",
    "readable",
    "human friendly",
    "pronouncable",
    "adjective",
    "word",
    "noun",
]
classifiers = ['Programming Language :: Python :: 3']
dependencies = ["typing-extensions>=4.12.2"]

[project.optional-dependencies]
dev = ["pytest>=8.3.2", "pre-commit>=3.5.0", "uniplot>=0.14.1"]
docs = ["mkdocs-material>=9.5.33", "mkdocstrings-python>=1.10.9"]

[project.urls]
Source = "https://github.com/h0uter/humid"
Issues = "https://github.com/h0uter/humid/issues"

[project.scripts]
humid = "humid.cli:generate"
hfid = "humid.cli:generate"
hfid-new-word = "humid.cli:check_word"

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


[tool.pdm]
distribution = true
build.package-dir = "src"

[tool.ruff]
extend-exclude = ["experiments"]


[tool.ruff.lint]
# See complete list: https://docs.astral.sh/ruff/rules/
select = [
    "I",   # isort
    "E",   # pycodestyle
    "W",   # pycodestyle
    "B",   # bugbear
    "F",   # pyflakes
    "UP",  # pyupgrade
    "RUF", # ruff
    "PL",  # pylint
    "D",   # pydocstyle
]
fixable = [
    "I", # isort
]


[tool.ruff.lint.pydocstyle]
convention = "google"