chroma-core/chroma

[ENH] Cleanup, lint, and sync requirements

Open

#2,361 opened on Jun 17, 2024

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

Repository metrics

Stars
 (27,958 stars)
PR merge metrics
 (Avg merge 1d 16h) (80 merged PRs in 30d)

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

Research direction
Examine the existing requirements files in pyproject.toml, requirements.txt, and requirements dev.txt for both the main project and clients. Identify redundancies and discrepancies. Propose a unified dependency management approach using a single source of truth (e.g., pyproject.toml) and add lint rules (e.g., with pre commit or a custom script) to enforce consistency across redundant files.
Tech stack
pythontypescript
Domain
build systemdeveloper experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonTypeScriptpipnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75