1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
[build-system]
build-backend = "hatchling.build"
requires = [
"hatch-vcs>=0.5",
"hatchling>=1.27",
]
[project]
name = "platformdirs"
description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
readme = "README.md"
keywords = [
"appdirs",
"application",
"cache",
"directory",
"log",
"user",
]
license = "MIT"
maintainers = [
{ name = "Bernát Gábor", email = "gaborjbernat@gmail.com" },
{ name = "Julian Berman", email = "Julian@GrayVines.com" },
{ name = "Ofek Lev", email = "oss@ofek.dev" },
{ name = "Ronny Pfannschmidt", email = "opensource@ronnypfannschmidt.de" },
]
requires-python = ">=3.10"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"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 :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Software Development :: Libraries :: Python Modules",
]
dynamic = [
"version",
]
urls.Changelog = "https://platformdirs.readthedocs.io/en/latest/changelog.html"
urls.Documentation = "https://platformdirs.readthedocs.io"
urls.Homepage = "https://github.com/tox-dev/platformdirs"
urls.Source = "https://github.com/tox-dev/platformdirs"
urls.Tracker = "https://github.com/tox-dev/platformdirs/issues"
[dependency-groups]
dev = [
{ include-group = "coverage" },
{ include-group = "docs" },
{ include-group = "fix" },
{ include-group = "pkg-meta" },
{ include-group = "test" },
{ include-group = "type" },
]
test = [
"appdirs==1.4.4",
"covdefaults>=2.3",
"diff-cover>=10.2",
"pytest>=8.4.2",
"pytest-cov>=7",
"pytest-mock>=3.15.1",
]
type = [
"ty>=0.0.16",
{ include-group = "release" },
{ include-group = "test" },
]
docs = [
"furo>=2025.9.25",
"proselint>=0.14",
"sphinx>=8.2.3",
"sphinx-autodoc-typehints>=3.2",
"sphinx-copybutton>=0.5.2",
"sphinx-design>=0.6.1",
"sphinx-sitemap>=2.6",
"sphinxcontrib-mermaid>=0.9.5",
"sphinxext-opengraph>=0.10.2",
]
coverage = [
"covdefaults>=2.3",
"coverage[toml]>=7.6.1",
"diff-cover>=10.2",
]
fix = [
"pre-commit-uv>=4.2",
]
pkg-meta = [
"check-wheel-contents>=0.6.3",
"twine>=6.2",
"uv>=0.10.2",
]
release = [
"gitpython>=3.1.46",
"pygithub>=2.8.1",
"pyyaml>=6.0.3",
]
[tool.hatch]
build.hooks.vcs.version-file = "src/platformdirs/version.py"
build.targets.sdist.include = [
"/src",
"/tests",
"/tox.toml",
]
version.source = "vcs"
[tool.ruff]
line-length = 120
format.preview = true
lint.select = [
"ALL",
]
lint.ignore = [
"COM812", # conflict
"CPY", # no copyright notices
"D203", # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
"D205", # 1 blank line required between summary line and description
"D213", # `multi-line-summary-second-line` (D213) conflicts with docstrfmt which uses D212 style
"D301", # Use `r"""` if any backslashes in a docstring
"D401", # The first line of docstring should be in imperative mood
"DOC", # no support for restructuredtext
"E501", # line length handled by ruff format (code) and docstrfmt (docstrings)
"RUF067", # `__init__` module should only contain docstrings and re-exports
"S104", # Possible binding to all interfaces
]
lint.per-file-ignores."tasks/**/*.py" = [
"D", # don't care about documentation in tasks scripts
"INP001", # no implicit namespace
"S603", # `subprocess` call: check for execution of untrusted input
"T201", # print allowed in scripts
]
lint.per-file-ignores."tests/**/*.py" = [
"D", # don't care about documentation in tests
"FBT", # don't care about booleans as positional arguments in tests
"INP001", # no implicit namespace
"PLC2701", # Private name import
"PLR0917", # Too many positional arguments
"PLR2004", # Magic value used in comparison, consider replacing with a constant variable
"S101", # asserts allowed in tests
"S603", # `subprocess` call: check for execution of untrusted input
]
lint.isort = { known-first-party = [
"platformdirs",
"tests",
], required-imports = [
"from __future__ import annotations",
] }
lint.preview = true
[tool.codespell]
builtin = "clear,usage,en-GB_to_en-US"
count = true
quiet-level = 3
[tool.pyproject-fmt]
max_supported_python = "3.14"
[tool.coverage]
run.parallel = true
run.plugins = [
"covdefaults",
]
paths.other = [
".",
"*/platformdirs",
"*\\platformdirs",
]
paths.source = [
"src",
".tox/*/lib/*/site-packages",
".tox\\*\\Lib\\site-packages",
"**/src",
"**\\src",
]
report.fail_under = 76
html.show_contexts = true
html.skip_covered = false
[tool.ty]
environment.python-version = "3.14"
|