GoldenViz 0.1.0a2

GoldenViz is a Python library that analyzes matplotlib and seaborn charts and checks whether they follow data visualization best practices (the Golden Rules of Data Visualization).

GoldenViz

GoldenViz is a lightweight Python library for checking Matplotlib charts against practical data visualization rules.

It is designed as a visual QA and teaching layer. GoldenViz does not create charts for you; it inspects charts you already made and returns structured feedback.

GoldenViz is inspired by the course and book: The 25 Golden Rules of Data Viz.

Installation

pip install GoldenViz

Then import the package with the same capitalization:

import GoldenViz as gv

Quickstart

import matplotlib.pyplot as plt
import GoldenViz as gv

fig, ax = plt.subplots()
ax.plot([2021, 2022, 2023], [10, 13, 16])
ax.set_title("Revenue trend by year")
ax.set_xlabel("Year")
ax.set_ylabel("Revenue (M EUR)")

gv.check(fig)

Running the code displays the Matplotlib chart first:

Then GoldenViz renders an HTML report below it:

GoldenViz report Automatic visual QA for the 25 Golden Rules.

PASS 25 WARNING 0 FAIL 0

View warnings and failures

Axis: Revenue trend by year

No warnings or failures for this axis.

Passing checks (25)

Rule	Status	Assessment
Clear title	PASS	Title detected: Revenue trend by year.
Axis labels	PASS	Both x-axis and y-axis labels are present.
Units and scale clarity	PASS	Numeric labels include detectable units or scale where applicable.

The full report contains all 25 passing checks.

The full report HTML fragment used in the documentation is available at docs/_static/goldenviz_installation_check_report.html.

To get a structured report instead of displaying it:

report = gv.analyze(fig)
print(report.summary_counts)

Notebook auto mode

import GoldenViz as gv

gv.auto()

When auto mode is enabled, GoldenViz tries to show a report after Matplotlib figures are rendered in notebook workflows.

Documentation

Full installation, usage, examples, API, citation, license, and trademark information are available in the documentation:

https://goldenviz.readthedocs.io

Project status

GoldenViz is currently an alpha package. The implementation is Matplotlib-first, with Seaborn charts supported when they produce standard Matplotlib axes.

GoldenViz uses heuristic checks. It can help detect common chart quality issues, but it does not replace human judgment and may produce false positives or false negatives.

See CHANGELOG.md for release notes.

Development

From a local checkout:

pip install -e .

For documentation work:

pip install -e ".[docs]"

For tests:

pip install -e ".[test]"
pytest

License

GoldenViz is free and open source software licensed under the GNU Affero General Public License version 3 or later (AGPL-3.0-or-later). See LICENSE.

Commercial licensing, enterprise use cases, hosted services, or integrations that require terms different from AGPLv3 may be available by separate written agreement.

GoldenViz and the GoldenViz logo are trademarks or claimed trademarks of Wajdi Ben Saad. Use of the code under AGPLv3 does not grant permission to use the GoldenViz name or logo to imply endorsement, official status, or partnership. See TRADEMARKS.md.

Contributing

Contributions are welcome. See CONTRIBUTING.md for the development workflow and contribution licensing terms.