pyproject.toml

[build-system]
requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]
build-backend = "hatchling.build"

[project]
name = "python-ulid"
description = "Universally unique lexicographically sortable identifier"
dynamic = ["version", "readme"]
license = "MIT"
requires-python = ">=3.10"
authors = [
    { name = "Martin Domke", email = "mail@martindomke.net" },
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS :: MacOS X",
    "Programming Language :: Python",
    "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",
    "Topic :: Software Development :: Libraries",
]
dependencies = [
    "typing-extensions; python_version < '3.11'",
]

[project.urls]
Homepage = "https://github.com/mdomke/python-ulid"
Documentation = "https://python-ulid.readthedocs.io"
Changelog = "https://python-ulid.readthedocs.io/en/latest/changelog.html"
Issues = "https://github.com/mdomke/python-ulid/issues"
CI = "https://github.com/mdomke/python-ulid/actions"
Repository = "https://github.com/mdomke/python-ulid"

[project.optional-dependencies]
pydantic = [
    "pydantic>=2.0"
]

[project.scripts]
ulid = "ulid.__main__:entrypoint"

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

[tool.hatch.build.targets.wheel]
packages = [
    "ulid",
]
[tool.hatch.build.targets.sdist]
exclude = [
    ".flox",
]

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

[tool.ruff.format]
preview = true

[tool.ruff.lint]
extend-fixable = ["RUF100", "I001"]
ignore = [
    "S101",   # Allow usage of asserts
    "A001",   # Allow shadowing bultins 
    "A003",   # Allow shadowing bultins on classes
    "EM101",  # Allow raw strings in exceptions
    "EM102",  # Allow f-strings in exceptions
    "EM102",  # Allow f-strings in exceptions
    "TRY003", # Allow "long" messages in exceptions
]

[tool.ruff.lint.per-file-ignores]
"docs/**/*" = [
  "INP001",   # Ignore possible static credentials
]

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

[tool.ruff.lint.isort]
force-single-line = true
lines-after-imports = 2
order-by-type = false

[tool.mypy]
disallow_untyped_defs = true
follow_imports = "normal"
ignore_missing_imports = true
pretty = true
show_column_numbers = true
show_error_codes = true
warn_no_return = false
warn_unused_ignores = true
plugins = [
  "pydantic.mypy",
]

[tool.uv]
default-groups = ["dev", "doc"]

[tool.pyrefly]
preset = "strict"
project-excludes = ["docs"]

[tool.poe.tasks]
test = "uv run --extra pydantic pytest --cov --cov-report=term-missing"
check-code = "uv run ruff check"
check-fmt = "uv run ruff format --check"
check-types = "uv run --extra pydantic pyrefly check"
check-docs = "uv run doc8 docs/source"
fmt = "uv run ruff format"
fix = "uv run ruff check --fix"
build = "uv build"
cov-combine = "coverage combine"
cov-xml = "coverage xml"

[tool.poe.tasks.docs]
help = "Build the HTML documentation"
cmd = "uv run --with-requirements requirements.txt make html"
cwd = "docs"

[tool.poe.tasks.check]
help = "Run all checks (code, format, types, docs)"
sequence = [
    { ref = "check-code" },
    { ref = "check-fmt" },
    { ref = "check-types" },
    { ref = "check-docs" },
]

[tool.coverage.run]
branch = true
parallel = true
source = ["ulid"]

[tool.doc8]
max-line-length = 100

[dependency-groups]
dev = [
    "coverage==7.15.*",
    "freezegun==1.5.*",
    "poethepoet==0.48.*",
    "prek==0.4.*",
    "pyrefly==1.1.*",
    "pytest==9.1.*",
    "pytest-cov==7.1.*",
    "ruff==0.15.*",
]
doc = [
    "doc8>=2.0.0",
    "sphinx==8.1.*",
]

[tool.hatch.metadata.hooks.fancy-pypi-readme]
content-type = "text/x-rst"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
path = "README.rst"
start-after = ".. teaser-begin"