You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-19Lines changed: 6 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ You have a cool idea, but do not know know if it fits with Code Carbon? You can
70
70
<!-- TOC --><aname="installation"></a>
71
71
### Installation
72
72
73
-
CodeCarbon is a Python package, to contribute to it, you need to have Python installed on your machine, natively or with [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/), or better, faster, stronger with [UV](https://github.com/astral-sh/uv).
73
+
CodeCarbon is a Python package, to contribute to it, you need to have Python installed on your machine, natively or with [UV](https://github.com/astral-sh/uv).
74
74
75
75
Between April 2024 and July 2025 we use Hatch for managing development environment. Since August 2025 we use UV manages the environments, Python versions, and dependencies - it's a fast, reliable way to work with Python projects.
76
76
@@ -258,7 +258,6 @@ Dependencies are defined in different places:
258
258
259
259
- In [pyproject.toml](pyproject.toml#L28), those are all the dependencies.
260
260
- In [uv.lock](uv.lock), those are the locked dependencies managed by UV, do not edit them.
261
-
- In [.conda/meta.yaml](.conda/meta.yaml#L21), those are the dependencies for the Conda pacakge targeting Python 3.7 and higher versions.
262
261
263
262
264
263
<!-- TOC --><aname="build-documentation-"></a>
@@ -288,20 +287,6 @@ to regenerate the html files.
288
287
- Wait for the Github Action `ReleaseDrafter` to finish running on the merge commit.
289
288
-[Edit the Draft release](https://github.com/mlco2/codecarbon/releases/) on Github and give it a tag, `v1.0.0` for the version 1.0.0. Github will automatically create a Git tag for it. Complete help [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
290
289
- A [Github Action](https://github.com/mlco2/codecarbon/actions)_Upload Python Package_ will be run automaticaly to upload the package.
291
-
- For conda, we now have a [feedstock](https://github.com/conda-forge/codecarbon-feedstock/pulls) to publish to Conda-Forge channel.
292
-
293
-
If you still want to publish to the Anaconda CodeCarbon channel:
294
-
295
-
Start a Docker image in the same directory and bind-mount the current directory with:
296
-
297
-
`docker run -ti --rm=true -v $PWD:/data continuumio/anaconda3`.
To run locally the dashboard application, you can use it out on a sample data file such as the one in `examples/emissions.csv`, and run it with the following command from the code base:
327
312
328
313
```bash
329
-
uv run --extra viz-legacy task carbonboard --filepath="examples/emissions.csv"
314
+
uv run --extra carbonboard task carbonboard --filepath="examples/emissions.csv"
> **Note:** The `viz-legacy` extra is deprecated but still works for backwards compatibility. It will be removed in v4.0.0. Please use `carbonboard` instead.
322
+
336
323
If you have the package installed, you can run the CLI command:
0 commit comments