Skip to content

Commit

Permalink
chore: add descriptions for tox list (#5169)
Browse files Browse the repository at this point in the history
  • Loading branch information
RogerHYang authored Oct 23, 2024
1 parent 1e829fe commit 2244c97
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package = wheel
wheel_build_env = .pkg

[testenv:phoenix_evals]
description = Run tests for the arize-phoenix-evals package
changedir = packages/phoenix-evals/
deps =
-r requirements/ci.txt
Expand All @@ -17,6 +18,7 @@ commands =
pytest -ra -x {posargs:.}

[testenv:phoenix_otel]
description = Run tests for the arize-phoenix-otel package
changedir = packages/phoenix-otel/
deps =
-r requirements/ci.txt
Expand All @@ -27,6 +29,7 @@ commands =
; pytest -ra -x {posargs:.}

[testenv:type_check_integration_tests]
description = Run type checking with mypy on integration tests
changedir = tests/integration
deps =
-r requirements/integration-tests.txt
Expand All @@ -37,6 +40,7 @@ commands =
mypy {posargs:.}

[testenv:integration_tests]
description = Run integration tests
pass_env =
CI_TEST_DB_BACKEND
changedir = tests/integration
Expand All @@ -49,6 +53,7 @@ commands =
pytest {posargs:.}

[testenv:type_check_unit_tests]
description = Run type checking with mypy on unit tests
changedir = tests/
deps =
-r requirements/unit-tests.txt
Expand All @@ -59,6 +64,7 @@ commands =
mypy {posargs:.}

[testenv:unit_tests]
description = Run unit tests
changedir = tests
deps =
-r requirements/unit-tests.txt
Expand All @@ -69,22 +75,25 @@ commands =
pytest --ignore=integration {posargs:.}

[testenv:type_check]
description = Run type checking with mypy on src/phoenix
deps =
-r requirements/type-check.txt
commands_pre =
uv pip install --strict --reinstall-package arize-phoenix .
commands =
uv pip list -v
mypy {posargs:.}
mypy {posargs:src/phoenix}

[testenv:clean_jupyter_notebooks]
description = Clear output and metadata from Jupyter notebooks
deps =
-r requirements/clean-jupyter-notebooks.txt
commands =
uv pip list -v
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --inplace {posargs}

[testenv:build_graphql_schema]
description = Export GraphQL schema to a file
changedir = app
deps =
-r requirements/build-graphql-schema.txt
Expand All @@ -95,6 +104,7 @@ commands =
strawberry export-schema phoenix.server.api.schema:schema -o schema.graphql

[testenv:build_openapi_schema]
description = Export OpenAPI schema to a file
changedir = schemas
commands_pre =
uv pip install --strict --reinstall-package arize-phoenix ../.
Expand All @@ -103,13 +113,15 @@ commands =
python -m phoenix.server.api.openapi.main -o openapi.json

[testenv:compile_protobuf]
description = Compile protobuf files
deps =
-r requirements/compile-protobuf.txt
commands =
uv pip list -v
python -m grpc_tools.protoc -I src/phoenix/proto --python_out=src/phoenix --mypy_out=src/phoenix src/phoenix/proto/trace/v1/evaluation.proto

[testenv:add_symlinks]
description = Add symlinks to packages (for editable install)
changedir = src/phoenix
allowlist_externals =
sh
Expand All @@ -118,6 +130,7 @@ commands =
sh -c '[ -e otel ] || ln -s ../../packages/phoenix-otel/src/phoenix/otel otel'

[testenv:remove_symlinks]
description = Remove symlinks to packages
changedir = src/phoenix
allowlist_externals =
unlink
Expand All @@ -126,6 +139,7 @@ commands =
unlink otel

[testenv:phoenix_main]
description = Run Phoenix server
pass_env=
PHOENIX_PORT
PHOENIX_GRPC_PORT
Expand All @@ -141,6 +155,7 @@ commands =
uv tool run arize-phoenix {posargs:serve}

[testenv:ruff]
description = Run ruff for formatting and linting
commands_pre =
uv tool install ruff@0.7.0
commands =
Expand Down

0 comments on commit 2244c97

Please sign in to comment.