Skip to content

Conversation

@benoit-cty
Copy link
Contributor

@benoit-cty benoit-cty commented Dec 19, 2025

Description

Files Modified:

  • ✏️ pyproject.toml - Renamed viz-legacy → carbonboard, removed redundant viz group, added backwards compatibility alias
  • ✏️ codecarbon/viz/carbonboard.py - Added dependency checks with helpful error messages
  • ✏️ docs/edit/visualize.rst - Added installation instructions and deprecation notice
  • ✏️ CONTRIBUTING.md - Updated commands and added deprecation notice
  • ✏️ .github/workflows/test-package.yml - Added CI steps for viz tests

Key Benefits:

  • 🎯 Better UX: Users get clear error messages if dependencies are missing
  • 🔄 Backwards Compatible: Existing viz-legacy installations continue to work
  • 📚 Clear Documentation: Installation instructions are prominent and clear
  • ✅ Better Testing: Viz tests now run automatically in CI
  • 🧹 Cleaner Code: Removed redundant viz dependency group

This fully addresses issue #1009 and improves the overall developer and user experience!

Related Issue

Please link to the issue this PR resolves: [issue #1009]

Motivation and Context

Users don't know how to install carbnboard.

How Has This Been Tested?

pip install codecarbon[carbonboard]
carbonboard --filepath="examples/emissions.csv

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@benoit-cty benoit-cty requested a review from a team as a code owner December 19, 2025 21:32
Copy link
Collaborator

@inimaz inimaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good thanks @benoit-cty !

@inimaz inimaz merged commit 4462829 into master Dec 22, 2025
11 checks passed
@inimaz inimaz deleted the documentation/carbonboard branch December 22, 2025 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants