arize-phoenix 3.25.0__tar.gz → 4.0.1__tar.gz

{arize_phoenix-3.25.0 → arize_phoenix-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arize-phoenix
-Version: 3.25.0
+Version: 4.0.1
 Summary: AI Observability and Evaluation
 Project-URL: Documentation, https://docs.arize.com/phoenix/
 Project-URL: Issues, https://github.com/Arize-ai/phoenix/issues
@@ -17,6 +17,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: <3.13,>=3.8
+Requires-Dist: aioitertools
+Requires-Dist: aiosqlite
+Requires-Dist: alembic<2,>=1.3.0
+Requires-Dist: cachetools
+Requires-Dist: grpcio
 Requires-Dist: hdbscan>=0.8.33
 Requires-Dist: jinja2
 Requires-Dist: numpy
@@ -28,6 +33,7 @@ Requires-Dist: openinference-semantic-conventions>=0.1.5
 Requires-Dist: opentelemetry-exporter-otlp
 Requires-Dist: opentelemetry-proto>=1.12.0
 Requires-Dist: opentelemetry-sdk
+Requires-Dist: opentelemetry-semantic-conventions
 Requires-Dist: pandas
 Requires-Dist: protobuf<6.0,>=3.20
 Requires-Dist: psutil
@@ -35,9 +41,10 @@ Requires-Dist: pyarrow
 Requires-Dist: requests
 Requires-Dist: scikit-learn
 Requires-Dist: scipy
-Requires-Dist: sortedcontainers
+Requires-Dist: sqlalchemy[asyncio]<3,>=2.0.4
+Requires-Dist: sqlean-py>=3.45.1
 Requires-Dist: starlette
-Requires-Dist: strawberry-graphql==0.208.2
+Requires-Dist: strawberry-graphql==0.227.2
 Requires-Dist: tqdm
 Requires-Dist: typing-extensions>=4.5; python_version < '3.12'
 Requires-Dist: typing-extensions>=4.6; python_version >= '3.12'
@@ -45,10 +52,21 @@ Requires-Dist: umap-learn
 Requires-Dist: uvicorn
 Requires-Dist: wrapt
 Provides-Extra: container
+Requires-Dist: opentelemetry-exporter-otlp; extra == 'container'
+Requires-Dist: opentelemetry-instrumentation-grpc; extra == 'container'
+Requires-Dist: opentelemetry-instrumentation-sqlalchemy; extra == 'container'
+Requires-Dist: opentelemetry-instrumentation-starlette; extra == 'container'
+Requires-Dist: opentelemetry-proto>=1.12.0; extra == 'container'
+Requires-Dist: opentelemetry-sdk; extra == 'container'
+Requires-Dist: opentelemetry-semantic-conventions; extra == 'container'
 Requires-Dist: prometheus-client; extra == 'container'
+Requires-Dist: py-grpc-prometheus; extra == 'container'
+Requires-Dist: strawberry-graphql[opentelemetry]==0.227.2; extra == 'container'
+Requires-Dist: uvloop; (platform_system != 'Windows') and extra == 'container'
 Provides-Extra: dev
 Requires-Dist: anthropic; extra == 'dev'
 Requires-Dist: arize[autoembeddings,llm-evaluation]; extra == 'dev'
+Requires-Dist: asyncpg; extra == 'dev'
 Requires-Dist: gcsfs; extra == 'dev'
 Requires-Dist: google-cloud-aiplatform>=1.3; extra == 'dev'
 Requires-Dist: hatch; extra == 'dev'
@@ -60,12 +78,14 @@ Requires-Dist: nbqa; extra == 'dev'
 Requires-Dist: pandas-stubs<=2.0.2.230605; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
 Requires-Dist: prometheus-client; extra == 'dev'
+Requires-Dist: psycopg[binary]; extra == 'dev'
 Requires-Dist: pytest-asyncio; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: pytest-lazy-fixture; extra == 'dev'
+Requires-Dist: pytest-postgresql; extra == 'dev'
 Requires-Dist: pytest==7.4.4; extra == 'dev'
 Requires-Dist: ruff==0.3.0; extra == 'dev'
-Requires-Dist: strawberry-graphql[debug-server]==0.208.2; extra == 'dev'
+Requires-Dist: strawberry-graphql[debug-server,opentelemetry]==0.227.2; extra == 'dev'
 Provides-Extra: evals
 Requires-Dist: arize-phoenix-evals>=0.3.0; extra == 'evals'
 Provides-Extra: experimental
@@ -74,6 +94,8 @@ Provides-Extra: llama-index
 Requires-Dist: llama-index-callbacks-arize-phoenix>=0.1.2; extra == 'llama-index'
 Requires-Dist: llama-index==0.10.3; extra == 'llama-index'
 Requires-Dist: openinference-instrumentation-llama-index>=1.2.0; extra == 'llama-index'
+Provides-Extra: pg
+Requires-Dist: asyncpg; extra == 'pg'
 Description-Content-Type: text/markdown
 
 <p align="center">

{arize_phoenix-3.25.0 → arize_phoenix-4.0.1}/pyproject.toml

@@ -31,25 +31,32 @@ dependencies = [
   "starlette",
   "uvicorn",
   "psutil",
-  "strawberry-graphql==0.208.2",
+  "strawberry-graphql==0.227.2",  # need to pin version because we're monkey-patching
   "pyarrow",
   "typing-extensions>=4.5; python_version<'3.12'",
   # A minimum version of typing-extensions==4.6.0 is needed to avoid this issue on Python 3.12: https://github.com/Azure/azure-sdk-for-python/issues/33442#issuecomment-1847886784
   "typing-extensions>=4.6; python_version>='3.12'",
   "scipy",
   "wrapt",
-  "sortedcontainers",
   "protobuf>=3.20, <6.0",
+  "grpcio",
   "tqdm",
   "requests",
   "opentelemetry-sdk",
   "opentelemetry-proto>=1.12.0",  # needed to avoid this issue: https://github.com/Arize-ai/phoenix/issues/2695
   "opentelemetry-exporter-otlp",
+  "opentelemetry-semantic-conventions",
   "openinference-semantic-conventions>=0.1.5",
   "openinference-instrumentation",
   "openinference-instrumentation-langchain>=0.1.12",
   "openinference-instrumentation-llama-index>=1.2.0",
   "openinference-instrumentation-openai>=0.1.4",
+  "sqlalchemy[asyncio]>=2.0.4, <3",
+  "alembic>=1.3.0, <2",
+  "aiosqlite",
+  "aioitertools",
+  "sqlean.py>=3.45.1",
+  "cachetools",
 ]
 dynamic = ["version"]
 
@@ -65,7 +72,10 @@ dev = [
   "pytest-asyncio",
   "pytest-cov",
   "pytest-lazy-fixture",
-  "strawberry-graphql[debug-server]==0.208.2",
+  "pytest-postgresql",
+  "asyncpg",
+  "psycopg[binary]",
+  "strawberry-graphql[debug-server,opentelemetry]==0.227.2",  # need to pin version because we're monkey-patching
   "pre-commit",
   "arize[AutoEmbeddings, LLM_Evaluation]",
   "llama-index>=0.10.3",
@@ -86,8 +96,21 @@ llama-index = [
   "llama-index-callbacks-arize-phoenix>=0.1.2",
   "openinference-instrumentation-llama-index>=1.2.0",
 ]
+pg = [
+  "asyncpg",
+]
 container = [
   "prometheus-client",
+  "opentelemetry-sdk",
+  "opentelemetry-proto>=1.12.0",
+  "opentelemetry-exporter-otlp",
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-instrumentation-starlette",
+  "opentelemetry-instrumentation-sqlalchemy",
+  "opentelemetry-instrumentation-grpc",
+  "py-grpc-prometheus",
+  "strawberry-graphql[opentelemetry]==0.227.2",  # need to pin version because we're monkey-patching
+  "uvloop; platform_system != 'Windows'",
 ]
 
 [project.urls]
@@ -105,14 +128,14 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
 packages = ["src/phoenix"]
 exclude = ["src/phoenix/evals/"]
-artifacts = ["src/phoenix/server/static"]
+artifacts = ["src/phoenix/server/static", "src/phoenix/db/migrations"]
 
 [tool.hatch.build]
 only-packages = true
 
 [tool.hatch.build.targets.sdist]
 exclude = ["src/phoenix/evals/", "packages/"]
-artifacts = ["src/phoenix/server/static"]
+artifacts = ["src/phoenix/server/static", "src/phoenix/db/migrations"]
 
 [tool.hatch.envs.default]
 dependencies = [
@@ -121,6 +144,9 @@ dependencies = [
   "pytest-asyncio",
   "pytest-cov",
   "pytest-lazy-fixture",
+  "pytest-postgresql",
+  "asyncpg",
+  "psycopg[binary]",
   "arize",
   "litellm>=1.0.3",
   "openai>=1.0.0",
@@ -134,7 +160,7 @@ dependencies = [
   "httpx", # For OpenAI testing
   "respx", # For OpenAI testing
   "nest-asyncio", # for executor testing
-  "pyfakefs", # for experimental storage implementations
+  "astunparse; python_version<'3.9'",  # `ast.unparse(...)` is only available starting with Python 3.9
 ]
 
 [tool.hatch.envs.type]
@@ -147,9 +173,20 @@ dependencies = [
   "types-requests",
   "types-protobuf",
   "types-setuptools",
+  "types-cachetools",
   "openai>=1.0.0",
   "litellm>=1.0.3",
   "prometheus_client",
+  "grpcio",
+  "opentelemetry-sdk",
+  "opentelemetry-proto>=1.12.0",
+  "opentelemetry-exporter-otlp",
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-instrumentation-starlette",
+  "opentelemetry-instrumentation-sqlalchemy",
+  "opentelemetry-instrumentation-grpc",
+  "py-grpc-prometheus",
+  "strawberry-graphql[opentelemetry]==0.227.2",  # need to pin version because we're monkey-patching
 ]
 
 [tool.hatch.envs.style]
@@ -248,7 +285,7 @@ check = [
 
 [tool.hatch.envs.gql]
 dependencies = [
-  "strawberry-graphql[cli]==0.208.2",
+  "strawberry-graphql[cli]==0.227.2",  # need to pin version because we're monkey-patching
   "requests",
 ]
 
@@ -308,12 +345,14 @@ module = [
   "sklearn.*",
   "arize.*",
   "wrapt",
-  "sortedcontainers",
   "langchain.*",
   "litellm",
   "nest_asyncio",
   "opentelemetry.*",
   "pyarrow",
+  "sqlean",
+  "grpc.*",
+  "py_grpc_prometheus.*",
 ]
 ignore_missing_imports = true
 

{arize_phoenix-3.25.0 → arize_phoenix-4.0.1}/src/phoenix/__init__.py

@@ -4,14 +4,19 @@ from importlib.machinery import ModuleSpec
 from types import ModuleType
 from typing import Any, Optional
 
-from .datasets.dataset import Dataset
-from .datasets.fixtures import ExampleDatasets
 from .inferences.fixtures import ExampleInferences, load_example
 from .inferences.inferences import Inferences
 from .inferences.schema import EmbeddingColumnNames, RetrievalEmbeddingColumnNames, Schema
 from .session.client import Client
 from .session.evaluation import log_evaluations
-from .session.session import NotebookEnvironment, Session, active_session, close_app, launch_app
+from .session.session import (
+    NotebookEnvironment,
+    Session,
+    active_session,
+    close_app,
+    delete_all,
+    launch_app,
+)
 from .trace.fixtures import load_example_traces
 from .trace.trace_dataset import TraceDataset
 from .version import __version__
@@ -34,8 +39,6 @@ Here are just a few of the things that phoenix does well:
 
 __all__ = [
     "__version__",
-    "Dataset",
-    "ExampleDatasets",
     "Inferences",
     "EmbeddingColumnNames",
     "RetrievalEmbeddingColumnNames",
@@ -45,6 +48,7 @@ __all__ = [
     "active_session",
     "close_app",
     "launch_app",
+    "delete_all",
     "Session",
     "load_example_traces",
     "TraceDataset",

arize_phoenix-4.0.1/src/phoenix/config.py

@@ -0,0 +1,215 @@
+import os
+import tempfile
+from logging import getLogger
+from pathlib import Path
+from typing import List, Optional
+
+logger = getLogger(__name__)
+
+# Phoenix environment variables
+ENV_PHOENIX_PORT = "PHOENIX_PORT"
+ENV_PHOENIX_GRPC_PORT = "PHOENIX_GRPC_PORT"
+ENV_PHOENIX_HOST = "PHOENIX_HOST"
+ENV_NOTEBOOK_ENV = "PHOENIX_NOTEBOOK_ENV"
+ENV_PHOENIX_COLLECTOR_ENDPOINT = "PHOENIX_COLLECTOR_ENDPOINT"
+"""
+The endpoint traces and evals are sent to. This must be set if the Phoenix
+server is running on a remote instance.
+"""
+ENV_PHOENIX_WORKING_DIR = "PHOENIX_WORKING_DIR"
+"""
+The directory in which to save, load, and export datasets. This directory must
+be accessible by both the Phoenix server and the notebook environment.
+"""
+ENV_PHOENIX_PROJECT_NAME = "PHOENIX_PROJECT_NAME"
+"""
+The project name to use when logging traces and evals. defaults to 'default'.
+"""
+ENV_PHOENIX_SQL_DATABASE_URL = "PHOENIX_SQL_DATABASE_URL"
+"""
+The SQL database URL to use when logging traces and evals.
+By default, Phoenix uses an SQLite database and stores it in the working directory.
+
+Phoenix supports two types of database URLs:
+- SQLite: 'sqlite:///path/to/database.db'
+- PostgreSQL: 'postgresql://@host/dbname?user=user&password=password' or 'postgresql://user:password@host/dbname'
+
+Note that if you plan on using SQLite, it's advised to to use a persistent volume
+and simply point the PHOENIX_WORKING_DIR to that volume.
+"""
+
+ENV_PHOENIX_ENABLE_PROMETHEUS = "PHOENIX_ENABLE_PROMETHEUS"
+"""
+Whether to enable Prometheus. Defaults to false.
+"""
+
+# Phoenix server OpenTelemetry instrumentation environment variables
+ENV_PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_HTTP_ENDPOINT = (
+    "PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_HTTP_ENDPOINT"
+)
+ENV_PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_GRPC_ENDPOINT = (
+    "PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_GRPC_ENDPOINT"
+)
+
+
+def server_instrumentation_is_enabled() -> bool:
+    return bool(
+        os.getenv(ENV_PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_HTTP_ENDPOINT)
+    ) or bool(os.getenv(ENV_PHOENIX_SERVER_INSTRUMENTATION_OTLP_TRACE_COLLECTOR_GRPC_ENDPOINT))
+
+
+def _get_temp_path() -> Path:
+    """Get path to  directory in which to store temp phoenix server files."""
+    return Path(tempfile.gettempdir()) / ".arize-phoenix"
+
+
+def get_pids_path() -> Path:
+    """Get path to directory in which to store temp phoenix instance pid files.
+    This directory is used to track any currently running instances of Arize Phoenix
+    on the host machine. The directory will be created if it does not exist.
+    """
+    path = _get_temp_path() / "pids"
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def get_running_pid() -> Optional[int]:
+    for file in get_pids_path().iterdir():
+        if file.name.isnumeric():
+            return int(file.name)
+    return None
+
+
+def get_working_dir() -> Path:
+    """
+    Get the working directory for saving, loading, and exporting datasets.
+    """
+    working_dir_str = os.getenv(ENV_PHOENIX_WORKING_DIR)
+    if working_dir_str is not None:
+        return Path(working_dir_str)
+    # Fall back to ~/.phoenix if PHOENIX_WORKING_DIR is not set
+    return Path.home().resolve() / ".phoenix"
+
+
+PHOENIX_DIR = Path(__file__).resolve().parent
+# Server config
+SERVER_DIR = PHOENIX_DIR / "server"
+HOST = "0.0.0.0"
+"""The host the server will run on after launch_app is called."""
+PORT = 6006
+"""The port the server will run on after launch_app is called."""
+GRPC_PORT = 4317
+"""The port the gRPC server will run on after launch_app is called.
+The default network port for OTLP/gRPC is 4317.
+See https://opentelemetry.io/docs/specs/otlp/#otlpgrpc-default-port"""
+GENERATED_DATASET_NAME_PREFIX = "phoenix_dataset_"
+"""The prefix of datasets that are auto-assigned a name."""
+WORKING_DIR = get_working_dir()
+"""The work directory for saving, loading, and exporting datasets."""
+
+ROOT_DIR = WORKING_DIR
+EXPORT_DIR = ROOT_DIR / "exports"
+DATASET_DIR = ROOT_DIR / "datasets"
+TRACE_DATASET_DIR = ROOT_DIR / "trace_datasets"
+
+
+def ensure_working_dir() -> None:
+    """
+    Ensure the working directory exists. This is needed because the working directory
+    must exist before certain operations can be performed.
+    """
+    logger.info(f"📋 Ensuring phoenix working directory: {WORKING_DIR}")
+    try:
+        for path in (
+            ROOT_DIR,
+            EXPORT_DIR,
+            DATASET_DIR,
+            TRACE_DATASET_DIR,
+        ):
+            path.mkdir(parents=True, exist_ok=True)
+    except Exception as e:
+        print(
+            "💥 Failed to initialize the working directory at "
+            + f"{WORKING_DIR} due to an error: {str(e)}."
+            + "Phoenix requires a working directory to persist data"
+        )
+        raise
+
+
+# Invoke ensure_working_dir() to ensure the working directory exists
+ensure_working_dir()
+
+
+def get_exported_files(directory: Path) -> List[Path]:
+    """
+    Yields the list of paths of exported files.
+
+    Parameters
+    ----------
+    directory: Path
+        Disk location to search exported files.
+
+    Returns
+    -------
+    list: List[Path]
+        List of paths of the exported files.
+    """
+    return list(directory.glob("*.parquet"))
+
+
+def get_env_port() -> int:
+    if not (port := os.getenv(ENV_PHOENIX_PORT)):
+        return PORT
+    if port.isnumeric():
+        return int(port)
+    raise ValueError(
+        f"Invalid value for environment variable {ENV_PHOENIX_PORT}: "
+        f"{port}. Value must be an integer."
+    )
+
+
+def get_env_grpc_port() -> int:
+    if not (port := os.getenv(ENV_PHOENIX_GRPC_PORT)):
+        return GRPC_PORT
+    if port.isnumeric():
+        return int(port)
+    raise ValueError(
+        f"Invalid value for environment variable {ENV_PHOENIX_GRPC_PORT}: "
+        f"{port}. Value must be an integer."
+    )
+
+
+def get_env_host() -> str:
+    return os.getenv(ENV_PHOENIX_HOST) or HOST
+
+
+def get_env_collector_endpoint() -> Optional[str]:
+    return os.getenv(ENV_PHOENIX_COLLECTOR_ENDPOINT)
+
+
+def get_env_project_name() -> str:
+    return os.getenv(ENV_PHOENIX_PROJECT_NAME) or DEFAULT_PROJECT_NAME
+
+
+def get_env_database_connection_str() -> str:
+    env_url = os.getenv(ENV_PHOENIX_SQL_DATABASE_URL)
+    if env_url is None:
+        working_dir = get_working_dir()
+        return f"sqlite:///{working_dir}/phoenix.db"
+    return env_url
+
+
+def get_env_enable_prometheus() -> bool:
+    if (enable_promotheus := os.getenv(ENV_PHOENIX_ENABLE_PROMETHEUS)) is None or (
+        enable_promotheus_lower := enable_promotheus.lower()
+    ) == "false":
+        return False
+    if enable_promotheus_lower == "true":
+        return True
+    raise ValueError(
+        f"Invalid value for environment variable {ENV_PHOENIX_ENABLE_PROMETHEUS}: "
+        f"{enable_promotheus}. Value values are 'TRUE' and 'FALSE' (case-insensitive)."
+    )
+
+
+DEFAULT_PROJECT_NAME = "default"

{arize_phoenix-3.25.0 → arize_phoenix-4.0.1}/src/phoenix/datetime_utils.py

@@ -1,4 +1,4 @@
-from datetime import datetime, timedelta, timezone
+from datetime import datetime, timedelta, timezone, tzinfo
 from typing import Any, Optional, Tuple, cast
 
 import pandas as pd
@@ -11,6 +11,23 @@ from pandas.core.dtypes.common import (
     is_object_dtype,
 )
 
+_LOCAL_TIMEZONE = datetime.now(timezone.utc).astimezone().tzinfo
+
+
+def normalize_datetime(
+    dt: Optional[datetime],
+    tz: Optional[tzinfo] = None,
+) -> Optional[datetime]:
+    """
+    If the input datetime is timezone-naive, it is localized as local timezone
+    unless tzinfo is specified.
+    """
+    if not isinstance(dt, datetime):
+        return None
+    if dt.tzinfo is None or dt.tzinfo.utcoffset(dt) is None:
+        dt = dt.replace(tzinfo=tz if tz else _LOCAL_TIMEZONE)
+    return dt.astimezone(timezone.utc)
+
 
 def normalize_timestamps(
     timestamps: "pd.Series[Any]",

arize_phoenix-4.0.1/src/phoenix/db/README.md

@@ -0,0 +1,25 @@
+# Database
+
+This module is responsible for the database connection and the migrations.
+
+## Migrations
+
+All migrations are managed by Alembic. Migrations are applied to the database automatically when the application starts.
+
+### Applying migrations
+
+To manually apply the migrations, run the following command:
+
+```bash
+alembic upgrade head
+```
+
+### Creating a migration
+
+All migrations are stored in the `migrations` folder. To create a new migration, run the following command:
+
+```bash
+alembic revision -m "your_revision_name"
+```
+
+Then fill the migration file with the necessary changes.

arize_phoenix-4.0.1/src/phoenix/db/__init__.py

@@ -0,0 +1,4 @@
+from .engines import get_printable_db_url
+from .migrate import migrate
+
+__all__ = ["migrate", "get_printable_db_url"]

arize_phoenix-4.0.1/src/phoenix/db/alembic.ini

@@ -0,0 +1,119 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Note this is overridden in .migrate during programatic migrations
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# NB: This is commented out intentionally as it is dynamic
+# See migrations/env.py
+# sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = WARN
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S