Skip to content

feat: Jupyter HTML output, public check() API, and --format html flag… - #137

Merged
mitulgarg merged 1 commit into
mainfrom
feat/jupyter-html-output
Jun 15, 2026
Merged

feat: Jupyter HTML output, public check() API, and --format html flag…#137
mitulgarg merged 1 commit into
mainfrom
feat/jupyter-html-output

Conversation

@mitulgarg

Copy link
Copy Markdown
Owner

… (v0.3.4)

  • Auto-detects Jupyter/Colab kernels via is_notebook() and renders rich self-contained HTML inline; falls back to terminal text everywhere else
  • New public API: from env_doctor import check; check() returns CheckReport with repr_html(), repr(), .html, and .to_dict()
  • --format {text,html,json} CLI flag on env-doctor check; --json/--ci unchanged
  • report/ module: is_notebook(), format_result_html() with inline CSS, no JS
  • Logo SVG bundled at report/logo.svg; replaces emoji in HTML header
  • Extracted collect_check_results() and render_check_text() so all renderers share a single detection pass
  • Optional [notebook] extra: pip install env-doctor[notebook]
  • 22 new unit tests in tests/unit/test_html_report.py

… (v0.3.4)

- Auto-detects Jupyter/Colab kernels via is_notebook() and renders rich
  self-contained HTML inline; falls back to terminal text everywhere else
- New public API: from env_doctor import check; check() returns CheckReport
  with _repr_html_(), __repr__(), .html, and .to_dict()
- --format {text,html,json} CLI flag on env-doctor check; --json/--ci unchanged
- report/ module: is_notebook(), format_result_html() with inline CSS, no JS
- Logo SVG bundled at report/logo.svg; replaces emoji in HTML header
- Extracted collect_check_results() and render_check_text() so all renderers
  share a single detection pass
- Optional [notebook] extra: pip install env-doctor[notebook]
- 22 new unit tests in tests/unit/test_html_report.py
@mitulgarg
mitulgarg merged commit d6404b6 into main Jun 15, 2026
4 checks passed
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.

1 participant