pyproject.toml

[project]
name = "b2"
description = "Command Line Tool for Backblaze B2"
authors = [
    { name = "Backblaze Inc", email = "support@backblaze.com" },
]
dynamic = ["version"]
requires-python = ">=3.8"
keywords = ["backblaze b2 cloud storage"]
license = {text = "MIT"}
readme = "README.md"
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Topic :: Software Development :: Libraries",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
]
dependencies = [
    "argcomplete>=3.5.2,<4",
    "arrow>=1.0.2,<2.0.0",
    "b2sdk>=2.7.0,<3",
    "docutils>=0.18.1",
    "idna~=3.4; platform_system == 'Java'",
    "importlib-metadata>=3.3; python_version < '3.8'",
    "phx-class-registry>=4.0,<5",
    "rst2ansi==0.1.5",
    "tabulate==0.9.0",
    "tqdm>=4.65.0,<5",
    "platformdirs>=3.11.0,<5",
    "setuptools>=60; python_version < '3.10'",  # required by phx-class-registry<4.1
]

[project.optional-dependencies]
# doc and licence are actually dev requirements, not optional
# requirements. They should be removed from this section when
# a breaking version is released.
doc = [
    "sadisplay>=0.4.9; python_version >= '3.9'",
    "sphinx>=7.2,<8; python_version >= '3.9'",
    "sphinx-argparse; python_version >= '3.9'",
    "sphinx-autobuild; python_version >= '3.9'",
    "sphinx-rtd-theme>=1.3,<2; python_version >= '3.9'",
    "sphinxcontrib-plantuml; python_version >= '3.9'"
]
license = [
    "pip>=23.1.0",
    "pip-licenses==3.5.5; python_version < '3.9'",
    "pip-licenses~=5.0; python_version >= '3.9'",
    "pipdeptree>=2.9,<3; python_version >= '3.9'",
    "prettytable~=3.7; python_version < '3.9'",
    "prettytable~=3.9; python_version >= '3.9'",
]
full = [
    "pydantic>=2.0.1,<3"
]

[project.urls]
Homepage = "https://github.com/Backblaze/B2_Command_Line_Tool"

[project.scripts]
b2 = "b2._internal.b2v4.__main__:main"
b2v3 = "b2._internal.b2v3.__main__:main"
b2v4 = "b2._internal.b2v4.__main__:main"

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

[tool.liccheck]
authorized_licenses = [
    "bsd",
    "new bsd",
    "bsd license",
    "new bsd license",
    "simplified bsd",
    "apache",
    "apache 2.0",
    "apache software",
    "apache software license",
    "lgpl",
    "gnu lgpl",
    "gnu library or lesser general public license (lgpl)",
    "lgpl with exceptions or zpl",
    "isc license",
    "isc license (iscl)",
    "mit",
    "mit license",
    "mozilla public license 2.0 (mpl 2.0)",
    "mpl-2.0",
    "psf",
    "python software foundation",
    "python software foundation license",
    "zpl 2.1",
]
unauthorized_licences = [
    "affero",
    "agpl",
    "gpl v3",
    "gpl v2",
    "gpl",
]
dependencies = true
optional_dependencies = ["doc", "full", "license"]

[tool.ruff]

# TODO add D
select = ["E", "F", "I", "UP"]
# TODO: remove E501 once docstrings are formatted
ignore = [
    "D100", "D105", "D107", "D200", "D202", "D203", "D205", "D212", "D400", "D401", "D415",
    "D101", "D102", "D103", "D104", # TODO remove once we have docstring for all public methods
    "E501", # TODO: remove E501 once docstrings are formatted
    "UP031",
]
line-length = 100
target-version = "py38"

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

[tool.ruff.per-file-ignores]
"__init__.py" = ["F401"]
"test/**" = ["D", "F403", "F405"]
"b2/console_tool.py" = ["E402"]

[tool.towncrier]
directory = "changelog.d"
filename = "CHANGELOG.md"
start_string = "<!-- towncrier release notes start -->\n"
underlines = ["", "", ""]
title_format = "## [{version}](https://github.com/Backblaze/B2_Command_Line_Tool/releases/tag/v{version}) - {project_date}"
issue_format = "[#{issue}](https://github.com/Backblaze/B2_Command_Line_Tool/issues/{issue})"

[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true

[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true

[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true

[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true

[[tool.towncrier.type]]
directory = "doc"
name = "Doc"
showcontent = true

[[tool.towncrier.type]]
directory = "infrastructure"
name = "Infrastructure"
showcontent = true

[tool.pdm]
distribution = "true"

[tool.pdm.build]
includes = ["b2"]

[tool.pdm.version]
source = "scm"

[tool.pdm.scripts]
assert_prod_python = "pdm run python -c 'import sys; assert sys.version_info >= (3, 11)'"
lock_prod_no_cross_platform = "pdm lock --lockfile pdm.prod.lock --group full --group test --strategy no_cross_platform"
lock_bundle = {composite=["assert_prod_python", "lock_prod_no_cross_platform"]}

[tool.pdm.dev-dependencies]
format = [
    "ruff~=0.8.4",
]
lint = [
    "ruff~=0.8.4",
    "pytest==8.3.3",
    "liccheck>=0.9.2",
    "setuptools>=60",  # required by liccheck
]
release = [
    "towncrier==23.11.0; python_version >= '3.8'",
]
test = [
    "coverage==7.2.7",
    "pexpect==4.9.0",
    "pytest==8.3.3",
    "pytest-cov==3.0.0",
    "pytest-forked==1.6.0",
    "pytest-xdist==2.5.0",
    "backoff==2.1.2",
    "more-itertools==8.13.0",
]
bundle = [
    "pyinstaller<6,>=5.13; python_version < \"3.13\"",
    "pyinstaller-hooks-contrib>=2023.6",
    "patchelf-wrapper==1.2.0; platform_system == \"Linux\"",
    "staticx~=0.13.9; platform_system == \"Linux\"",
]