Repolode
Submit
timkpaine

timkpaine/jupyterlab-email

A JupyterLab extension that lets you email notebooks, with or without code, as inline content, HTML or PDF attachments.

View on GitHub
Stars
60
Forks
2
Open issues
2
Last commit
5 days ago

What is it?

jupyterlab_email adds a feature to JupyterLab for sending notebooks by email without leaving the browser. A notebook can be sent as inline email content or as an HTML or PDF attachment, and input code cells can be included or left out.

The extension can also attach output data from a notebook as CSV, TSV, PDF, PNG, or Excel spreadsheet files. SMTP servers are configured in the Jupyter notebook config file, and a Python function is available for generating the email from a notebook path or model.

It is installed with pip and two Jupyter enable commands, and it is licensed under Apache-2.0.

Key features

  • 01Sends notebooks inline in the email body or as HTML or PDF attachments.
  • 02Can include or omit input code cells.
  • 03Attaches output data as CSV, TSV, PDF, PNG, or Excel files.
  • 04Configures SMTP servers through the Jupyter notebook config file.
  • 05Excel writer defaults to xlsxwriter and can be changed.

Use cases

  • Sharing a finished analysis notebook with colleagues by email.
  • Sending a PDF or HTML report generated from a notebook to stakeholders.
  • Emailing query results or tables from a notebook as spreadsheet attachments.

Quick start

  1. 1

    Install the Python package from PyPI

    pip install jupyterlab_email
  2. 2

    Install the JupyterLab extension

    jupyter labextension install jupyterlab_email
  3. 3

    Enable the server extension

    jupyter serverextension enable --py jupyterlab_email
  4. 4

    Add your SMTP server settings to jupyter_notebook_config.py

Things to know

  • You must configure your own SMTP server and credentials before sending email.
  • The README's install commands use older JupyterLab extension and server extension syntax, so they may not work on current JupyterLab versions.

Topics

#jupyter#jupyterlab#jupyterlab-extension#email#python#notebook#email-notebooks

FAQ

What is jupyterlab-email?
A JupyterLab extension that lets you email notebooks, with or without code, as inline content, HTML or PDF attachments. jupyterlab_email adds a feature to JupyterLab for sending notebooks by email without leaving the browser. A notebook can be sent as inline email content or as an HTML or PDF attachment, and input code cells can be included or left out.
Is jupyterlab-email free to use? What license does it have?
jupyterlab-email is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is jupyterlab-email still maintained?
Actively maintained. The last commit to jupyterlab-email was on Nov 2, 2026.
What can I use jupyterlab-email for?
Sharing a finished analysis notebook with colleagues by email. Sending a PDF or HTML report generated from a notebook to stakeholders. Emailing query results or tables from a notebook as spreadsheet attachments.
How do I install jupyterlab-email?
Install the Python package from PyPI: pip install jupyterlab_email Install the JupyterLab extension: jupyter labextension install jupyterlab_email Enable the server extension: jupyter serverextension enable --py jupyterlab_email Add your SMTP server settings to jupyter_notebook_config.py
Where can I get jupyterlab-email?
The source code and installation instructions are on GitHub: https://github.com/timkpaine/jupyterlab-email

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects