Skip to main content

Exports Jupyter notebook into beautiful and dynamic HTML report.

Project description


Pretty Jupyter

Simple package for beautiful & dynamic reports

Documentation Status

demo preview

Introduction

Pretty Jupyter is a package that creates beautifully styled and dynamic html webpage from Jupyter notebook.

Check out the demo and compare it with the default jupyter.

Main Features

  • :point_right: Visually appealing styles.
  • :point_right: Table of Contents can be automatically generated.
  • :point_right: Using Python variables in Markdown.
  • :point_right: Tabsets for hiding section content behind clickable tabs.
  • :point_right: Code Folding: Show/Hide code to filter out unnecessary content.
  • :point_right: Themes: Selection from a wide variaty of available themes.
  • :point_right: Wide range of configuration options with sensible defaults.
  • :point_right: Unobtrusive syntax that works well in notebook environments.

All these features are integrated directly in the output html page. Therefore there is no need for an interpreter running in the backend.

Installation

pip install pretty-jupyter

Usage

jupyter nbconvert --to html --template pj /path/to/ipynb/file

Resources

Credits

  • RMarkdown: RMarkdown served as a great inspiration when making this package.
  • nbconvert: Pretty Jupyter uses nbconvert underhood. Its great extendability allowed this project to be created.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pretty_jupyter-2.0.8.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

pretty_jupyter-2.0.8-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file pretty_jupyter-2.0.8.tar.gz.

File metadata

  • Download URL: pretty_jupyter-2.0.8.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pretty_jupyter-2.0.8.tar.gz
Algorithm Hash digest
SHA256 38ed19c81b39f0ef59ece774c511d411eafd0c39e7419cb875b2025cbc70fbe0
MD5 d2ba732e12e376abfac3943a5a125567
BLAKE2b-256 c86dfaaa6171d6e01b654cba1550a94c8d09a01533c63c2db3966ac6336d7ba8

See more details on using hashes here.

File details

Details for the file pretty_jupyter-2.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for pretty_jupyter-2.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c6b990c9be8653cb7ea2b2e3183e40122a1a02103db949270fd7d2cf179797a8
MD5 d4c4178180e16ad08571faec3ee6e348
BLAKE2b-256 d66fa037545a3dd6983d0fb7cf7ed8aa8f2bf537d86b102049ec606bd742dacf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page