pyproject.toml

[build-system]
requires = ["setuptools", "wheel"]

[project]
name = "kili"
version = "2.162.1"
description = "Python client for Kili Technology labeling tool"
readme = "README.md"
authors = [{ name = "Kili Technology", email = "contact@kili-technology.com" }]
license = { file = "LICENSE.txt" }
requires-python = ">=3.8"
classifiers = [
  "Intended Audience :: Science/Research",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: Apache Software License",
  "Programming Language :: Python",
  "Topic :: Software Development",
  "Topic :: Scientific/Engineering",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX",
  "Operating System :: Unix",
  "Operating System :: MacOS",
  "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 :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = [
  "pandas >= 1.0.0, < 3.0.0",
  "click >= 8.0.0, < 9.0.0",
  "requests >= 2.0.0, < 3.0.0",
  "tabulate >= 0.9.0, < 0.10.0",
  "tenacity >= 8.0.0, < 9.0.0",
  "tqdm >= 4.0.0, < 5.0.0",
  "typeguard >= 4, < 5",
  "typing-extensions >= 4.1.0, < 5.0.0",
  "pyparsing >= 3.0.0, < 4.0.0",
  "websocket-client >= 1.0.0, < 2.0.0",
  "pyyaml >= 6.0, < 7.0",
  "Pillow >=9.0.0, <11.0.0",
  "cuid >= 0.4, < 0.5",
  "urllib3 >= 1.26, < 3",
  "ffmpeg-python >= 0.2.0, < 0.3.0",
  "gql[requests,websockets] >= 3.5.0b5, < 4.0.0",
  "filelock >= 3.0.0, < 4.0.0",
  "pip-system-certs >= 4.0.0, < 5.0.0; platform_system=='Windows'",
  "pyrate-limiter >= 3, < 4",
  "shapely >= 1.8, < 3",
]
urls = { homepage = "https://github.com/kili-technology/kili-python-sdk" }

[project.scripts]
kili = "kili.entrypoints.cli:main"


[project.optional-dependencies]
dev = [
  # release
  "bump2version",
  # tests
  "pytest",
  "pytest-mock",
  "pytest-cov",
  "pytest-xdist[psutil]",
  "pytest-timeout",
  # documentation
  "mkdocs",
  "mkdocs-material",
  "mkdocstrings",
  "mkdocstrings-python-legacy",
  "mkdocs-click",
  "mike",
  "pymdown-extensions",
  # linting
  "pre-commit >= 3.3.0, < 4.0.0",
  "pylint ==3.0.3",
  "pyright ==1.1.347",
  # notebooks tests
  "nbformat",
  "nbconvert",
  "ipykernel",
  # profiling
  "pyinstrument",
  # dead code detection
  "vulture==2.11",
  "dead==1.5.2",
  # other optional dependencies
  "opencv-python >= 4.0.0, < 5.0.0",
  "azure-storage-blob >= 12.0.0, < 13.0.0",
]
image-utils = ["opencv-python >= 4.0.0, < 5.0.0"]
azure = ["azure-storage-blob >= 12.0.0, < 13.0.0"]

[tool.pyright]
exclude = ["**/__pycache__", ".github/scripts/upload_test_stats_datadog.py"]
pythonVersion = "3.8"
typeCheckingMode = "basic"

[tool.ruff]
select = ["ALL"]
src = ["src"]
line-length = 100
target-version = "py38"
extend-include = ["*.ipynb"]
ignore = [
  "ANN101",  # missing type for `self`
  "COM812",  # missing trailing comma
  "E501",    # line too long
  "E731",    # do not assign a lambda expression, use a def
  "EM101",   # use variable instead of string literal in exception
  "EM102",   # avoid using f-string in exception messages
  "FA100",   # Missing `from __future__ import annotations`, but uses `typing`
  "FBT001",  # boolean-type-hint-positional-argument
  "FBT002",  # boolean-type-hint-keyword-argument
  "PLR0913", # Too many arguments to function call
  "TD002",   # Missing author in TODO"
  "TRY003",  # Avoid specifying long messages outside the exception class
]

[tool.ruff.per-file-ignores]
"**test**" = [
  "ANN001",  # missing type annotation for function argument
  "ANN002",  # missing type annotation for args
  "ANN003",  # missing type annotation for kwargs
  "ANN101",  # missing type annotation for self in method
  "ANN201",  # missing return type annotation
  "ARG001",  # unused function argument
  "ARG002",  # unused method argument
  "D100",    # Missing docstring in public module
  "D101",    # Missing docstring in public class
  "D102",    # Missing docstring in public method
  "D103",    # Missing docstring in public function
  "ERA001",  # found commented out code
  "INP001",  # __init__.py missing
  "ISC003",  # Explicitly concatenated string should be implicitly concatenated"
  "N802",    # function name should be lowercase
  "N806",    # variable should be lowercase
  "PERF401", # Use a list comprehension to create a transformed list"
  "PGH003",  # use specific rule codes when ignoring type issues
  "PLR2004", # magic value used in comparison
  "S101",    # use of assert detected
  "SIM115",  # Use context handler for opening files
  "SLF001",  # private member accessed
  "T201",    # print found
]
"*.ipynb" = [
  "E402", # Module level import not at top of file"
]

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

[tool.ruff.format]
line-ending = "lf"

[tool.ruff.isort]
known-first-party = ["src", "tests"]

[tool.pytest]
ini_options = { pythonpath = ["src", "."] }
aliases = ["test = pytest"]