Skip to content

Commit b129d96

Browse files
author
benoit-cty
committed
task
1 parent 7efabb2 commit b129d96

2 files changed

Lines changed: 5 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,9 +316,9 @@ Inside the docker container, run:
316316
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:
317317

318318
```bash
319-
uv run carbonboard --filepath="examples/emissions.csv"
319+
uv run --extra viz-legacy task carbonboard --filepath="examples/emissions.csv"
320320

321-
# or
321+
# or, if you don't want to use UV
322322
pip install codecarbon["viz"]
323323
python codecarbon/viz/carbonboard.py --filepath="examples/emissions.csv"
324324
```
@@ -335,7 +335,7 @@ carbonboard --filepath="examples/emissions.csv" --port=8050
335335
To test the new dashboard that uses the API, run:
336336

337337
```sh
338-
uv run dashboard
338+
uv run task local
339339
```
340340

341341
Then, click on the url displayed in the terminal.

pyproject.toml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ dev = [
6161
"mypy",
6262
"pytest>=7.4.4",
6363
]
64-
# TODO: Put in detached ?
6564
doc = [
6665
"sphinx",
6766
"sphinx_rtd_theme",
@@ -115,14 +114,13 @@ codecarbon = "codecarbon.cli.main:main"
115114

116115
[tool.taskipy.tasks]
117116
pre-commit-install = { cmd = "pre-commit install", help = "Install pre-commit hook." }
118-
local = "cd carbonserver && uvicorn main:app --reload"
119-
server-ci = "cd carbonserver && uvicorn main:app --host 0.0.0.0 --port 8008"
117+
dashboard = "cd carbonserver && uvicorn main:app --reload"
118+
dashboard-ci = "cd carbonserver && uvicorn main:app --host 0.0.0.0 --port 8008"
120119
docker = "docker-compose up -d"
121120
test-api-unit = "cd carbonserver && python -m pytest -vv tests/api/routers/test_projects.py && python -m pytest -vv tests/api/service/ && python -m pytest -vv tests/api/usecase/"
122121
test-api-integ = "cd carbonserver && python -m pytest -vv tests/api/integration/"
123122
setup-db = "cd carbonserver && python3 -m alembic -c carbonserver/database/alembic.ini upgrade head"
124123
downgrade-db = "cd carbonserver && python -m alembic -c carbonserver/database/alembic.ini downgrade base"
125-
run = "cd dashboard && python carbon_board_API.py"
126124
build-doc = "cd docs/edit && make docs"
127125
precommit-install = "pre-commit install"
128126
precommit-update = "pre-commit autoupdate"
@@ -134,7 +132,6 @@ test-package = "CODECARBON_ALLOW_MULTIPLE_RUNS=True pytest -vv -m 'not integ_tes
134132
test-package-integ = "CODECARBON_ALLOW_MULTIPLE_RUNS=True python -m pytest -vv tests/"
135133
docs = "cd docs/edit && make docs"
136134
carbonboard = "python codecarbon/viz/carbonboard.py"
137-
dashboard = "cd dashboard && python carbon_board_API.py"
138135

139136
[tool.bumpver]
140137
current_version = "3.0.0_rc3"

0 commit comments

Comments
 (0)