Skip to main content

Sending emails from JupyterLab

Project description

jupyterlab_email

A jupyterlab extension to email notebooks from the browser.

Build Status codecov PyPI PyPI npm

Options

  • Inline notebook as email, with code
  • Inline notebook as email, without code
  • Send notebook as HTML attachment, with code
  • Send notebook as HTML attachment, without code
  • Send notebook as PDF attachment, with code
  • Send notebook as PDF attachment, without code
  • Attach output data as CSV, TSV, PDF, PNG, or Excel Spreadsheet

Install

pip install jupyterlab_email
jupyter labextension install jupyterlab_email
jupyter serverextension enable --py jupyterlab_email

Adding templates

install the server extension, and add the following to jupyter_notebook_config.py

c.JupyterLabEmail.smtp_servers = [{'name': 'gmail',
                                   'domain': 'gmail.com',
                                   'username': '<YOUR USERNAME>',
                                   'smtp': 'smtp.gmail.com',
                                   'port': 465}]

Create email from notebook:

Use the function in jupyterlab_email._email

def make_email(path, model, from_, type='email', template='', code=False, subject='',
               also_attach='none', also_attach_pdf_template='', also_attach_html_template=''):
    '''
        path        : path to notebook
        model       : notebook itself (in case deployment strips outputs or
                      notebook not available except through ContentsManager)
        from_       : address to send the email from
        type        : type to convert notebook to
        template    : template to use when converting notebook
        code        : include input cells in notebook
        subject     : subject of email
        also_attach : also attach pdf/html/both
    '''

Attach dataframe as csv or spreadsheet

In jupyterlab_email.attachments

def attach(data, filename, type):

Modify jupyterlab_email.attachments.EXCEL_ENGINE to use a different excel writer (defaults to xlsxwriter)

Inline LaTeX

In jupyterlab_email.attachments

def latex(expression):
    import matplotlib.pyplot as plt
    fig, ax = plt.subplots(figsize=(10, 1))
    ax.xaxis.set_visible(False)
    ax.yaxis.set_visible(False)
    ax.axis('off')
    plt.text(0, 0.6, r'$%s$' % expression, fontsize=25)
    plt.show()

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

jupyterlab_email-0.2.4.tar.gz (208.7 kB view details)

Uploaded Source

Built Distribution

jupyterlab_email-0.2.4-py2.py3-none-any.whl (60.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jupyterlab_email-0.2.4.tar.gz.

File metadata

  • Download URL: jupyterlab_email-0.2.4.tar.gz
  • Upload date:
  • Size: 208.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.0.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.10

File hashes

Hashes for jupyterlab_email-0.2.4.tar.gz
Algorithm Hash digest
SHA256 112f3f481058f40c4656051e5e77b1963e8cd131db0366b403c6cfcb6e14f893
MD5 01a9bfa3f8d3aa871a424a1799ccf57e
BLAKE2b-256 aec9d336b6ce48f32abdff50e5ac9fc202a156bbb79932c5833ae64b7cc062c5

See more details on using hashes here.

File details

Details for the file jupyterlab_email-0.2.4-py2.py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_email-0.2.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 60.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.0.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.10

File hashes

Hashes for jupyterlab_email-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b6dfe0cc4fe5d1616a4257d1047c6b6debf2d88fb50d2aa3a83411fce380aa64
MD5 6c34c89d65611c415621d330e1530f92
BLAKE2b-256 648476ccd6e0302d8288b041e2dc4f2255a22de41cfc1c86c299a683ded83c32

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