pyproject.toml

[project]
name = "arize-phoenix"
description = "ML Observability in your notebook"
readme = "README.md"
requires-python = ">=3.8, <3.12"
license = "Elastic-2.0"
license-files = { paths = ["LICENSE", "IP_NOTICE"] }
keywords = [
  "Observability",
  "Monitoring",
  "Explainability",
]
authors = [
  { name = "Arize AI", email = "phoenix-devs@arize.com" },
]
classifiers = [
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
]
dependencies = [
  "scikit-learn<1.3.0",
  "numpy",
  "pandas",
  "jinja2",
  "umap-learn",
  "hdbscan>=0.8.33, <1.0.0",
  "starlette",
  "uvicorn",
  "psutil",
  "strawberry-graphql==0.208.2",
  "pyarrow",
  "typing-extensions",
  "scipy",
  "wrapt",
  "sortedcontainers",
  "protobuf>=3.20, <5.0",
  "ddsketch",
]
dynamic = ["version"]

[project.optional-dependencies]
dev = [
  "black[jupyter]",
  "gcsfs",
  "hatch",
  "jupyter",
  "nbqa",
  "ruff==0.0.290",
  "pandas-stubs<=2.0.2.230605",  # version 2.0.3.230814 is causing a dependency conflict.
  "pytest",
  "pytest-cov",
  "pytest-lazy-fixture",
  "strawberry-graphql[debug-server]==0.208.2",
  "pre-commit",
  "arize[AutoEmbeddings, LLM_Evaluation]",
  "llama-index>=0.8.29",
  "langchain>=0.0.293",
]
experimental = [
  "tenacity",
]

[project.urls]
Documentation = "https://docs.arize.com/phoenix/"
Issues = "https://github.com/Arize-ai/phoenix/issues"
Source = "https://github.com/Arize-ai/phoenix"

[tool.hatch.version]
path = "src/phoenix/__init__.py"

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

[tool.hatch.build.targets.wheel]
packages = ["src/phoenix"]
artifacts = ["src/phoenix/server/static"]

[tool.hatch.build]
only-packages = true

[tool.hatch.build.hooks.jupyter-builder]
dependencies = ["hatch-jupyter-builder"]
build-function = "hatch_jupyter_builder.npm_builder"
ensured-targets = ["src/phoenix/server/static/index.js"]
skip-if-exists = ["src/phoenix/server/static/index.js"]

[tool.hatch.build.hooks.jupyter-builder.build-kwargs]
path = "app"
source_dir = "app"

[tool.hatch.build.targets.sdist]
artifacts = ["src/phoenix/server/static"]

[tool.hatch.envs.default]
dependencies = [
  "pandas==1.4.0",
  "pytest",
  "pytest-cov",
  "pytest-lazy-fixture",
  "arize",
  "langchain>=0.0.293",
  "llama-index>=0.8.29",
  "openai",
  "tenacity",
  "nltk==3.8.1",
  "sentence-transformers==2.2.2",
  "pydantic<2",  # for @root_validator in llama-index
  "requests",
  "protobuf==3.20",  # version minimum (for tests)
  "responses",
  "tiktoken"
]

[tool.hatch.envs.type]
dependencies = [
  "mypy==1.5.1",
  "llama-index>=0.8.29",
  "pandas-stubs<=2.0.2.230605",  # version 2.0.3.230814 is causing a dependency conflict.
  "types-psutil",
  "types-tqdm",
  "types-requests",
  "types-protobuf",
]

[tool.hatch.envs.style]
detached = true
dependencies = [
  "black~=23.3.0",
  "black[jupyter]~=23.3.0",
  "ruff~=0.0.290",
]

[tool.hatch.envs.notebooks]
detached = true
dependencies = [
  "jupyter",
]

[tool.hatch.envs.docs]
detached = true
dependencies = [
  "interrogate",
]

[tool.hatch.envs.default.scripts]
tests = "pytest {args}"
coverage = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/phoenix --cov=tests {args}"

[[tool.hatch.envs.test.matrix]]
python = ["3.8", "3.11"]

[tool.pytest.ini_options]
addopts = [
  "-rA",
  "--import-mode=importlib",
  "--doctest-modules",
]
testpaths = [
  "tests",
]

[tool.coverage.run]
branch = true
parallel = true
omit = [
  "**/__init__.py",
]

[tool.coverage.report]
fail_under=30
show_missing=true
sort="cover"
exclude_lines = [
  "no cov",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
]

[tool.hatch.envs.type.scripts]
check = [
  "mypy .",
]

[tool.hatch.envs.style.scripts]
check = [
  "black --check --diff --color .",
  "ruff .",
]
fix = [
  "black .",
  "ruff --fix .",
]

[tool.hatch.envs.notebooks.scripts]
clean = [
  "jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --inplace **/*.ipynb **/**/*.ipynb",
]

[tool.hatch.envs.publish]
dependencies = [
  "check-wheel-contents",
  "twine",
]

[tool.hatch.envs.publish.scripts]
testpypi = [
  "check-wheel-contents dist/",
  "twine upload  --verbose --repository testpypi dist/*",
]
pypi = [
  "check-wheel-contents dist/",
  "twine upload --verbose dist/*",
]

[tool.black]
line-length = 100
exclude = '_pb2\.pyi?$'

[tool.hatch.envs.docs.scripts]
check = [
  "interrogate -vv src/",
]

[tool.hatch.envs.gql]
dependencies = [
  "strawberry-graphql[cli]==0.208.2",
]

[tool.hatch.envs.gql.scripts]
build = 'strawberry export-schema phoenix.server.api.schema:schema > app/schema.graphql'

[tool.hatch.envs.proto]
detached = true
dependencies = [
  "grpcio-tools==1.54.3",
  "mypy-protobuf==3.5.0",
]

[tool.hatch.envs.proto.scripts]
recompile = "python -m grpc_tools.protoc -I src/phoenix/proto --python_out=src/phoenix --mypy_out=src/phoenix src/phoenix/proto/trace/v1/trace.proto"

[tool.interrogate]
fail-under = 0
# generate-badge = "badges/"
omit-covered-files = true
ignore-init-method = true
ignore-init-module = true
ignore-magic = false
ignore-semiprivate = false
ignore-private = false
ignore-property-decorators = false
ignore-module = false
ignore-nested-functions = false
ignore-nested-classes = false
ignore-setters = false

[tool.mypy]
plugins = ["strawberry.ext.mypy_plugin", "pydantic.mypy"]
disallow_untyped_calls = true
disallow_untyped_defs = true
disallow_incomplete_defs  = true
strict = true
exclude = [
  "dist/",
  "scripts/data/",
  "sdist/",
  "tests/",
  "tutorials/",
]

[[tool.mypy.overrides]]
module = [
  "hdbscan",
  "umap",
  "numba.*",
  "scipy.*",
  "sklearn.*",
  "arize.*",
  "wrapt",
  "sortedcontainers",
  "langchain.*",
]
ignore_missing_imports = true

[tool.ruff]
exclude = [".git", "__pycache__", "docs/source/conf.py", "*_pb2.py*"]
ignore-init-module-imports = true
line-length = 100
select = ["E", "F", "W", "I"]
target-version = "py38"

[tool.ruff.isort]
force-single-line = false