pyproject.toml

[build-system]
requires = ["setuptools>=68", "setuptools-scm[toml]"]
build-backend = "setuptools.build_meta"


[project]
name = "rosbags"
authors = [
  { name = "Ternaris", email = "team@ternaris.com" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "License :: OSI Approved :: Apache Software License",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Topic :: Scientific/Engineering",
  "Typing :: Typed",
]
description = "Pure Python library to read, modify, convert, and write rosbag files."
dependencies = [
  "lz4",
  "numpy",
  "ruamel.yaml",
  "typing_extensions >= 4.5",
  "zstandard",
]
dynamic = ["version"]
keywords = [
  "cdr",
  "conversion",
  "deserialization",
  "idl",
  "mcap",
  "message",
  "msg",
  "reader",
  "ros",
  "ros2",
  "rosbag",
  "rosbag2",
  "serialization",
  "writer",
]
license = { text = "Apache-2.0" }
readme = "README.rst"
requires-python = ">=3.10"

[project.optional-dependencies]
dev = [
  "declinate",
  "mypy",
  "pytest",
  "pytest-cov",
  "reuse",
  "ruff",
  "sphinx",
  "sphinx-autodoc-typehints",
  "sphinx-rtd-theme",
]

[project.scripts]
rosbags-convert = "rosbags.convert.cli:main"

[project.urls]
Homepage = "https://gitlab.com/ternaris/rosbags"
Documentation = "https://ternaris.gitlab.io/rosbags"
Source = "https://gitlab.com/ternaris/rosbags"
Issues = "https://gitlab.com/ternaris/rosbags/issues"
Changelog = "https://gitlab.com/ternaris/rosbags/-/blob/master/CHANGES.rst"


[tool.coverage]
report.exclude_lines = [
  "pragma: no cover",
  "if TYPE_CHECKING:",
  "if __name__ == '__main__':",
]
report.show_missing = true
report.skip_covered = true
run.branch = true
run.source = ["src"]


[tool.mypy]
disallow_any_explicit = true
explicit_package_bases = true
mypy_path = "src"
strict = true


[tool.pytest.ini_options]
addopts = ["--verbose"]


[tool.ruff]
line-length = 100
namespace-packages = ["docs", "docs/examples", "tools/bench", "tools/compare"]

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

[tool.ruff.lint]
select = [
  "ALL",
  "D204",
  "D400",
  "D401",
  "D404",
  "D413",
]
ignore = [
  "ANN101",
  "C901",
  "PLR0911",
  "PLR0912",
  "PLR0913",
  "PLR0915",
  "PLR2004",
  # allow asserts
  "S101",
  # trailing comma
  "COM812",
  # single line string concat
  "ISC001",
]

[tool.ruff.lint.isort]
combine-as-imports = true
force-wrap-aliases = true
known-first-party = ["rosbags"]

[tool.ruff.lint.flake8-copyright]
notice-rgx = "(?i)# (C)opyright 2020 - 2024 Ternaris\n# (S)PDX-License-Identifier: Apache-2.0"

[tool.ruff.lint.flake8-quotes]
avoid-escape = false
inline-quotes = "single"

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


[tool.setuptools_scm]