diff --git a/litellm-proxy-extras/build_and_publish.md b/litellm-proxy-extras/build_and_publish.md new file mode 100644 index 0000000000..19ed0e34c6 --- /dev/null +++ b/litellm-proxy-extras/build_and_publish.md @@ -0,0 +1,91 @@ +# Build & Publish `litellm-proxy-extras` + +This runbook covers building and publishing a new version of the `litellm-proxy-extras` PyPI package. For use by litellm engineers only. + +## Prerequisites + +- All `schema.prisma` files are in sync (see [migration_runbook.md](./migration_runbook.md) Step 0) +- Migration has been generated and committed +- You are in the `litellm-proxy-extras/` directory + +## Step 1: Bump the Version + +Update the version in `pyproject.toml`: + +```bash +cd litellm-proxy-extras + +# Check current version +grep 'version' pyproject.toml +``` + +Edit `pyproject.toml` and bump the version (both `[tool.poetry].version` and `[tool.commitizen].version`). + +## Step 2: Install Build Dependencies + +```bash +pip install build twine +``` + +## Step 3: Clean Old Artifacts + +```bash +rm -rf dist/ build/ *.egg-info +``` + +## Step 4: Build the Package + +```bash +python3 -m build +``` + +This creates `.tar.gz` and `.whl` files in the `dist/` directory. + +Verify the build output: + +```bash +ls -la dist/ +``` + +## Step 5: Upload to PyPI + +```bash +twine upload dist/* +``` + +You will be prompted for your PyPI API token: + +``` +Enter your API token: pypi-... +``` + +> Use `__token__` as the username and your PyPI API token as the password. + +## Quick Reference (Copy-Paste) + +```bash +cd litellm-proxy-extras +rm -rf dist/ build/ *.egg-info +python3 -m build +twine upload dist/* +``` + +--- + +## Do you want to build and publish a new `litellm-proxy-extras` package? (y/n) + +If **yes**, run the following commands in order: + +```bash +cd litellm-proxy-extras +pip install build twine +rm -rf dist/ build/ *.egg-info +python3 -m build +twine upload dist/* +``` + +When `twine upload` runs, enter your PyPI credentials: +- **Username:** `__token__` +- **Password:** *(paste your PyPI API key)* + +If **no**, you're done — no package publish needed. diff --git a/litellm-proxy-extras/migration_runbook.md b/litellm-proxy-extras/migration_runbook.md index 93948f24b1..3310b1626a 100644 --- a/litellm-proxy-extras/migration_runbook.md +++ b/litellm-proxy-extras/migration_runbook.md @@ -2,7 +2,35 @@ This is a runbook for creating and running database migrations for the LiteLLM proxy. For use for litellm engineers only. -## Quick Start +## Step 0: Sync All `schema.prisma` Files + +Before doing anything else, make sure all `schema.prisma` files in the repo are in sync. There are multiple copies that must match: + +| File | Purpose | +|------|---------| +| `schema.prisma` (repo root) | Source of truth | +| `litellm/proxy/schema.prisma` | Used by the proxy server | +| `litellm-proxy-extras/litellm_proxy_extras/schema.prisma` | Used for migration generation | + +**Sync process:** + +```bash +# 1. Diff all schema files against the root source of truth +diff schema.prisma litellm/proxy/schema.prisma +diff schema.prisma litellm-proxy-extras/litellm_proxy_extras/schema.prisma + +# 2. If there are differences, copy the root schema to all locations +cp schema.prisma litellm/proxy/schema.prisma +cp schema.prisma litellm-proxy-extras/litellm_proxy_extras/schema.prisma + +# 3. Verify all files are now identical +diff schema.prisma litellm/proxy/schema.prisma && echo "proxy schema in sync" || echo "MISMATCH" +diff schema.prisma litellm-proxy-extras/litellm_proxy_extras/schema.prisma && echo "extras schema in sync" || echo "MISMATCH" +``` + +> **Do NOT proceed to migration generation until all schema files are identical.** + +## Step 1: Quick Start — Generate Migration ```bash # Install deps (one time) @@ -43,8 +71,13 @@ rm -rf litellm-proxy-extras/litellm_proxy_extras/migrations/[empty_dir] ## Rules -- Update `schema.prisma` first +- Sync all `schema.prisma` files first (Step 0) +- Update `schema.prisma` at the repo root first, then sync copies - Review generated SQL before committing - Use descriptive migration names - Never edit existing migration files - Commit schema + migration together + +--- + +**Done with migration?** See [build_and_publish.md](./build_and_publish.md) to publish a new `litellm-proxy-extras` package.