mlco2 / mlco2/codecarbon

Migrate API server to pydantic v2

Open
#1,056 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1.9k
Forks
323
Avg merge
1d 12h
Merged PRs (30d)
12

Description

Current API server (carbonserver/carbonserver/api) uses pydantic v1.

It would be interesting to migrate to v2. The migration comes with breaking changes.

Migration guide from pydantic team --> https://docs.pydantic.dev/latest/migration/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in carbonserver/carbonserver/api and compare its current Pydantic v1 usage with the Pydantic migration guide linked in the issue. Identify the breaking changes that affect the API server, then verify that the API has been migrated to Pydantic v2 and its existing behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.