chroma-core/chroma

[ENH] Cleanup, lint, and sync requirements

Open

#2361 opened on Jun 17, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Rust (27,958 stars) (2,247 forks)batch import
by-chromacontributorsenhancementgood first issue

Description

Chroma has several places where we manage python dependencies / requirements

At the top level of the project:

For the thin python client:

A similar situation exists for the TypeScript client.

It's easy to miss adjusting these, for example when we need to pin or update a dependency as in https://github.com/chroma-core/chroma/pull/2360

We should unify these as much as possible, and add lint rules when they absolutely must be redundant.

Contributor guide

Tech stack
pythontypescript
Domain
toolingbuild system
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of Python dependency managementBasic understanding of linting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by reviewing the current dependency files listed in the issue: root's pyproject.toml, requirements.txt, requirements dev.txt, and the corresponding files in clients/python/. Also check the TypeScript client's package.json or similar. Understand the dependencies and any version pins. Look at the recent PR #2360 for an example where a dependency needed to be updated across multiple files. Propose a plan to consolidate these files, for example by using pyproject.toml as the single source of truth for Python dependencies and generating requirements.txt from it. Then, add a lint rule (e.g., using a custom script or a tool like pre commit) to ensure that any changes to pyproject.toml are reflected in the other files. Discuss the approach with the assignee or maintainers before implementation.