pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [ "setuptools>=61" ]

[project]
name = "supervision"
version = "0.32.0.dev"
description = "A set of easy-to-use utils that will come in handy in any Computer Vision project"
readme = "README.md"
keywords = [
  "AI",
  "deep-learning",
  "DL",
  "machine-learning",
  "ML",
  "Roboflow",
  "vision",
]
license = "MIT"
maintainers = [
  { name = "Piotr Skalski", email = "piotr@roboflow.com" },
]
authors = [
  { name = "Roboflow et al.", email = "develop@roboflow.com" },
]
requires-python = ">=3.10"
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "Intended Audience :: Education",
  "Intended Audience :: Science/Research",
  "Operating System :: MacOS",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX :: Linux",
  "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 :: 3.15",
  "Topic :: Multimedia :: Graphics",
  "Topic :: Multimedia :: Video",
  "Topic :: Scientific/Engineering",
  "Topic :: Scientific/Engineering :: Artificial Intelligence",
  "Topic :: Scientific/Engineering :: Image Recognition",
  "Topic :: Software Development",
  "Typing :: Typed",
]
dependencies = [
  "av>=14.2",
  "defusedxml>=0.7.1",
  "matplotlib>=3.6",
  "numpy>=1.21.2",
  "pillow>=9.4",
  "pydeprecate>=0.9,<0.14",
  "pyyaml>=5.3",
  "requests>=2.26",
  "scipy>=1.10",
  "tqdm>=4.62.3"
]
optional-dependencies.geotiff = [
  "rasterio>=1.3", # 1.3 introduced stable window-read API and CRS.is_projected
]
optional-dependencies.metrics = [
  "pandas>=2",
]
urls.Documentation = "https://supervision.roboflow.com/latest/"
urls.Homepage = "https://github.com/roboflow/supervision"
urls.Repository = "https://github.com/roboflow/supervision"

[dependency-groups]
dev = [
  "docutils!=0.21",
  "faster-coco-eval>=1.8",
  "ipywidgets>=8.1.1",
  "jupytext>=1.16.1",
  "nbconvert>=7.14.2",
  "notebook>=6.5.3,<8",
  "packaging",
  "pre-commit>=3.8",
  "pycocotools>=2.0.11",
  "pytest>=7.2.2,<10",
  "pytest-cov>=4,<8",
  "scikit-learn>=1.7",
  "tox>=4.11.4",
  "types-tqdm",
]
docs = [
  "mike>=2",
  "mkdocs-git-committers-plugin-2>=2.4.1; python_version>='3.10' and python_version<'4'",
  "mkdocs-git-revision-date-localized-plugin>=1.2.4",
  "mkdocs-jupyter>=0.24.3",
  "mkdocs-material[imaging]>=9.7",
  "mkdocstrings>=1,<1.1",
  "mkdocstrings-python>=2,<3",
]
build = [
  "build>=1,<1.7",
  "twine>=5.1.1,<8",
  "wheel>=0.40,<0.49",
]

[tool.setuptools]
packages.find.where = [ "src" ]
packages.find.include = [ "supervision*" ]
include-package-data = false
package-data.supervision = [ "py.typed" ]
# exclude = [ "docs*", "tests*", "examples*" ]

[tool.ruff]
target-version = "py310"
line-length = 88
indent-width = 4
# Exclude a variety of commonly ignored directories.
exclude = [
  ".bzr",
  ".direnv",
  ".eggs",
  ".git",
  ".git-rewrite",
  ".hg",
  ".mypy_cache",
  ".nox",
  ".pants.d",
  ".pytype",
  ".ruff_cache",
  ".svn",
  ".tox",
  ".venv",
  "__pypackages__",
  "_build",
  "buck-out",
  "build",
  "dist",
  "docs",
  "node_modules",
  "venv",
  "yarn-error.log",
  "yarn.lock",
]
# Like Black, indent with spaces, rather than tabs.
format.indent-style = "space"
# Like Black, use double quotes for strings.
format.quote-style = "double"
# Like Black, automatically detect the appropriate line ending.
format.line-ending = "auto"
# Like Black, respect magic trailing commas.
format.skip-magic-trailing-comma = false
# Enable linting rules for code style, imports, and best practices.
lint.select = [
  "A",   # flake8-builtins - https://docs.astral.sh/ruff/rules/#flake8-builtins-a
  "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
  "F",   # Pyflakes - https://docs.astral.sh/ruff/rules/#pyflakes-f
  "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
  "PT",  # pytest - https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
  "Q",   # flake8-quotes - https://docs.astral.sh/ruff/rules/#flake8-quotes-q
  "RUF", # Ruff-specific rules - https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
  "S",   # bandit - https://docs.astral.sh/ruff/rules/#flake8-bandit-s
  "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
  "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#pycodestyle-w
]
lint.ignore = []
lint.per-file-ignores.".github/_tests/**" = [
  "S101", # Use of `assert` detected: assert in test utilities is safe
  "S603", # `subprocess` call: subprocess with hardcoded args in test utilities is safe
]
lint.per-file-ignores."__init__.py" = [ "E402", "F401" ]
lint.per-file-ignores."notebooks/**" = [
  "PT018", # Assertion should be broken down into multiple parts
  "S101",  # Use of `assert` detected
]
lint.per-file-ignores."src/**" = [
  "S101", # TODO: Replace asserts with proper error handling
]
lint.per-file-ignores."tests/**" = [
  "S101", # Use of `assert` detected
  "S603", # `subprocess` call: subprocess with hardcoded args in test utilities is safe
]
lint.unfixable = []
# Allow unused variables when underscore-prefixed.
lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
lint.flake8-quotes.docstring-quotes = "double"
lint.flake8-quotes.inline-quotes = "double"
lint.flake8-quotes.multiline-quotes = "double"
lint.isort.no-sections = false
lint.isort.order-by-type = true
# Flag errors (`C901`) whenever the complexity level exceeds 5.
lint.mccabe.max-complexity = 20
lint.pydocstyle.convention = "google"
lint.pylint.max-args = 20

[tool.codespell]
ignore-words-list = "STrack,sTrack,strack"
skip = "*.ipynb"
count = true
quiet-level = 3

[tool.docformatter]
recursive = true
wrap-summaries = 88
wrap-descriptions = 88

[tool.mypy]
mypy_path = "src"
explicit_package_bases = true
ignore_missing_imports = false
python_version = "3.10"
warn_unused_ignores = true
strict = true
overrides = [
  { module = [ "examples.*", "tests.*" ], ignore_errors = true },
  { module = [
    "tests",
    "tests.annotators.*",
    "tests.assets.*",
    "tests.classification.*",
    "tests.conftest",
    "tests.cv2.*",
    "tests.dataset.*",
    "tests.depth.*",
    "tests.detection.test_compact_mask",
    "tests.detection.test_compact_mask_integration",
    "tests.detection.test_compact_mask_iou",
    "tests.detection.test_compact_mask_union",
    "tests.detection.test_core",
    "tests.detection.test_csv",
    "tests.detection.test_from_adapters",
    "tests.detection.test_from_sam",
    "tests.detection.test_geometry_contract",
    "tests.detection.test_geometry_dispatch",
    "tests.detection.test_inference_slicer_compact",
    "tests.detection.test_json",
    "tests.detection.test_json_snapshot",
    "tests.detection.test_line_counter",
    "tests.detection.test_polygon_zone_annotator",
    "tests.detection.test_polygonzone",
    "tests.detection.test_ultralytics_arrays",
    "tests.detection.test_vlm",
    "tests.detection.tools.test_inference_slicer",
    "tests.detection.tools.test_inference_slicer_geotiff",
    "tests.detection.tools.test_smoother",
    "tests.detection.tools.test_transformers",
    "tests.detection.utils.test_boxes",
    "tests.detection.utils.test_converters",
    "tests.detection.utils.test_internal",
    "tests.detection.utils.test_iou_and_nms",
    "tests.detection.utils.test_masks",
    "tests.detection.utils.test_matching",
    "tests.detection.utils.test_polygons",
    "tests.detection.utils.test_vlms",
    "tests.draw.*",
    "tests.geometry.*",
    "tests.helpers",
    "tests.metrics.coco_reference",
    "tests.metrics.conftest",
    "tests.metrics.test_core",
    "tests.metrics.test_detection",
    "tests.metrics.test_f1_score",
    "tests.metrics.test_keypoint_mean_average_precision",
    "tests.metrics.test_lazy_imports",
    "tests.metrics.test_mean_average_precision",
    "tests.metrics.test_mean_average_precision_area",
    "tests.metrics.test_mean_average_precision_limits",
    "tests.metrics.test_mean_average_recall",
    "tests.metrics.test_oriented_bounding_box_metrics",
    "tests.metrics.test_precision",
    "tests.metrics.test_precision",
    "tests.metrics.test_recall",
    "tests.metrics.test_recall",
    "tests.metrics.test_size_bucket_regressions",
    "tests.metrics.test_sklearn_parity",
    "tests.metrics.utils.*",
    "tests.test_public_api",
    "tests.test_validate_deprecations",
    "tests.utils.conftest",
    "tests.utils.test_conversion",
    "tests.utils.test_file",
    "tests.utils.test_image",
    "tests.utils.test_image_window",
    "tests.utils.test_internal",
    "tests.utils.test_iterables",
    "tests.utils.test_logger",
    "tests.utils.test_notebook",
    "tests.utils.test_sinks",
    "tests.utils.test_video",
    "tests.validators.*",
  ], ignore_errors = false },
  { module = [ "supervision._cv2" ], warn_unused_ignores = false },
]

[tool.pytest]
ini_options.testpaths = [ "src", "tests" ]
ini_options.norecursedirs = [ ".git", ".venv", "build", "dist", "docs", "examples", "notebooks" ]
ini_options.addopts = [
  "--doctest-modules",
  "--color=yes",
]
ini_options.filterwarnings = [
  "error::DeprecationWarning",
]
ini_options.doctest_optionflags = "ELLIPSIS NORMALIZE_WHITESPACE"

[tool.autoflake]
check = true
imports = [ "cv2", "supervision" ]