scriptoriumadmin/litellm
1
0
Fork 0
mirror of https://github.com/BerriAI/litellm.git synced 2026-08-28 05:25:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 48
litellm/docs/my-website/docs/contributing.md
stuxf a6c30b30bf
build: migrate packaging, CI, and Docker from Poetry to uv (#25007) 
* build: migrate packaging metadata to uv

* ci: move automation and local tooling to uv

* docker: migrate image builds and runtime setup to uv

* docs: update install and deployment guidance for uv

* chore: align auxiliary scripts and tests with uv

* test: harden test_litellm isolation

* fix: keep release and health check images self-contained

* build: pin uv tooling and health check deps

* test: isolate bedrock image request formatting from suite state

* test: cover sandbox executor requirements flow

* ci: fix circleci no-op command steps

* ci: fix circleci publish workflow parsing

* fix: stabilize remaining uv migration CI checks

* ci: increase matrix test timeout headroom

* fix: restore published docker and license coverage

* fix: restore proxy runtime build parity

* fix: restore proxy extras parity and venv migrations

* ci: persist uv path across circleci steps

* fix: keep psycopg binary in default test env

* docker: preserve prisma cache across stages

* test: run local proxy checks through uv python

* build: restore runtime deps moved into ci

* build: refresh uv lock after upstream merge

* fix: restore module import in test_check_migration after merge

The conflict resolution imported only the function but the test body
references check_migration as a module throughout.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: revert dependency promotions, remove nodejs-wheel-binaries, fix Docker layer caching

- Move google-generativeai, Pillow, tenacity back to ci group (they are
  lazily imported and bloat the base SDK install needlessly)
- Remove nodejs-wheel-binaries from extra_proxy and proxy-dev (redundant
  in Docker where system Node.js is already installed via apk)
- Remove all nodejs-wheel node replacement and venv npm patching blocks
  from Dockerfiles since the wheel is no longer installed
- Add --no-default-groups to CodSpeed benchmark workflow so the benchmark
  environment matches the old minimal pip install footprint
- Apply standard uv two-phase Docker pattern: copy metadata first, install
  deps (cached layer), then copy source and install project
- Replace CircleCI enterprise no-op with proper uv sync command

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: regenerate uv.lock after removing nodejs-wheel-binaries

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(ci): use cache/restore instead of cache to prevent cache poisoning

The old workflow used actions/cache/restore (read-only). The uv migration
changed it to actions/cache (read-write), which zizmor flags as a cache
poisoning risk. Restore the safer read-only variant.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(ci): disable setup-uv built-in cache to silence cache-poisoning alert

The setup-uv action enables caching by default, which zizmor flags as a
cache poisoning risk. Disable it since we already use a read-only
cache/restore step.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(ci): disable setup-uv cache in publish workflow

Silences zizmor cache-poisoning alert. Publishing workflow runs
infrequently on protected branches so caching adds no real benefit.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(test): remove duplicate verbose_logger mock in test_check_migration

The logger was patched twice — first via mocker.patch() then via
mocker.patch.object(autospec=True). The second call fails because
autospec cannot inspect an already-mocked attribute. Remove the
redundant first patch.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix(ci): free disk space before Docker build in test-server-root-path

The Dockerfile.non_root build ran out of disk on the CI runner. Remove
Android SDK, .NET, Boost, and GHC toolchains (~12GB) to free space.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-09 11:46:23 -07:00

2.6 KiB
Raw Blame History

Contributing - UI

Thanks for contributing to the LiteLLM UI! This guide will help you set up your local development environment.

1. Clone the repo

git clone https://github.com/BerriAI/litellm.git
cd litellm

2. Start the Proxy

Create a config file (e.g., config.yaml):

model_list:
  - model_name: gpt-4o
    litellm_params:
      model: openai/gpt-4o

general_settings:
  master_key: sk-1234
  database_url: postgresql://<user>:<password>@<host>:<port>/<dbname>
  store_model_in_db: true

Start the proxy on port 4000:

uv run litellm --config config.yaml --port 4000

The UI comes pre-built in the repo. Access it at http://localhost:4000/ui

3. UI Development

There are two options for UI development:

Option A: Development Mode (Hot Reload)

This runs the UI on port 3000 with hot reload. The proxy runs on port 4000.

cd ui/litellm-dashboard
npm install
npm run dev

Login flow:

  1. Go to http://localhost:3000
  2. You'll be redirected to http://localhost:4000/ui for login
  3. After logging in, manually navigate back to http://localhost:3000/
  4. You're now authenticated and can develop with hot reload

:::note If you experience redirect loops or authentication issues, clear your browser cookies for localhost or use Build Mode instead. :::

Option B: Build Mode

This builds the UI and copies it to the proxy. Changes require rebuilding.

  1. Make your code changes in ui/litellm-dashboard/src/

  2. Build the UI

cd ui/litellm-dashboard
npm install
npm run build

After building, copy the output to the proxy:

cp -r out/* ../../litellm/proxy/_experimental/out/

Then restart the proxy and access the UI at http://localhost:4000/ui

4. Pre-PR Checklist

Before submitting your pull request, make sure the following pass locally from ui/litellm-dashboard/:

Run tests related to your changes:

npx vitest run src/components/path/to/YourComponent.test.tsx

Tests are co-located with components (e.g., TeamInfo.tsx → TeamInfo.test.tsx). If you add a new component, add a corresponding .test.tsx file next to it.

Run the build:

npm run build

These map to the ui_tests and ui_build CI checks.

5. Submitting a PR

  1. Create a new branch for your changes:
git checkout -b feat/your-feature-name
  1. Stage and commit your changes:
git add .
git commit -m "feat: description of your changes"
  1. Push to your fork:
git push origin feat/your-feature-name
  1. Create a Pull Request on GitHub following the PR template