pyproject.toml

[build-system]
requires = [
    "hatchling",
]
build-backend = "hatchling.build"

[project]
name = "videostream2py"
version = "0.0.4"
description = "stream2py interface to video"
readme = "README.md"
requires-python = ">=3.10"
license = "Apache-2.0"
keywords = [
    "video",
    "stream",
    "stream2py",
    "opencv",
    "webcam",
    "real-time",
]
authors = [
    { name = "Thor Whalen" },
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.12",
    "Topic :: Multimedia :: Video",
    "Topic :: Multimedia :: Video :: Capture",
]
dependencies = [
    "stream2py",
    "opencv-python",
]

[project.urls]
Homepage = "https://github.com/i2mint/videostream2py"

[project.optional-dependencies]
dev = [
    "pytest>=7.0",
    "pytest-cov>=4.0",
    "ruff>=0.1.0",
]
docs = [
    "sphinx>=6.0",
    "sphinx-rtd-theme>=1.0",
]

[tool.hatch.build.targets.wheel]
# The tests live inside the package dir (so `testpaths = ["videostream2py"]`
# finds them), but they are not part of what an installing user asked for:
# they import pytest, which is only a `dev` extra, so shipping them would put
# an unsatisfiable import inside the installed distribution. They stay in the
# sdist and the repo; only the wheel drops them.
exclude = [
    "videostream2py/tests",
]

[tool.ruff]
line-length = 88
target-version = "py310"
exclude = [
    "**/*.ipynb",
    ".git",
    ".venv",
    "build",
    "dist",
    "tests",
    "examples",
    "scrap",
]

[tool.ruff.lint]
select = [
    "D100",
]
ignore = [
    "D203",
    "E501",
    "B905",
]

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

[tool.ruff.lint.per-file-ignores]
"**/tests/*" = [
    "D",
]
"**/examples/*" = [
    "D",
]
"**/scrap/*" = [
    "D",
]

[tool.pytest.ini_options]
minversion = "6.0"
testpaths = [
    "videostream2py",
]
doctest_optionflags = [
    "NORMALIZE_WHITESPACE",
    "ELLIPSIS",
]

[tool.wads.ops.libgl]
# opencv-python's binary wheels link against libGL. The GitHub Ubuntu runner
# images do not always ship it, and then `import cv2` fails at pytest
# collection time. The macOS/Windows wheels need nothing extra, hence no
# entries for those platforms.
description = "OpenGL runtime library (libGL.so.1), needed by opencv-python on Linux"
url = "https://pypi.org/project/opencv-python/"
check.linux = "ldconfig -p | grep -q libGL.so.1"
install.linux = ["sudo apt-get update", "sudo apt-get install -y libgl1"]

[tool.wads.ci]
project_name = "videostream2py"

[tool.wads.ci.commands]
pre_test = []
test = []
post_test = []
lint = []
format = []

[tool.wads.ci.env]
required_envvars = []
test_envvars = []
extra_envvars = []

[tool.wads.ci.env.defaults]

[tool.wads.ci.quality.ruff]
enabled = true

[tool.wads.ci.quality.black]
enabled = false

[tool.wads.ci.quality.mypy]
enabled = false

[tool.wads.ci.testing]
enabled = true
python_versions = [
    "3.10",
    "3.12",
]
pytest_args = [
    "-v",
    "--tb=short",
]
coverage_enabled = true
coverage_threshold = 0
coverage_report_format = [
    "term",
    "xml",
]
exclude_paths = [
    "examples",
    "scrap",
    "docsrc",
]
test_on_windows = true

[tool.wads.ci.metrics]
enabled = true
config_path = ".github/umpyre-config.yml"
storage_branch = "code-metrics"
python_version = "3.10"
force_run = false

[tool.wads.ci.build]
sdist = true
wheel = true

[tool.wads.ci.publish]
enabled = true
skip_ci_marker = "[skip ci]"
publish_marker = "[publish]"

[tool.wads.ci.docs]
enabled = true
builder = "epythet"
ignore_paths = [
    "tests/",
    "scrap/",
    "examples/",
]