Metadata-Version: 2.1
Name: jupyterlab_email
Version: 0.2.2
Summary: Sending emails from JupyterLab
Home-page: https://github.com/timkpaine/jupyterlab_email
Author: Tim Paine
Author-email: t.paine154@gmail.com
License: Apache 2.0
Description: # jupyterlab_email
        A jupyterlab extension to email notebooks from the browser.
        
        [![Build Status](https://dev.azure.com/tpaine154/jupyter/_apis/build/status/timkpaine.jupyterlab_email?branchName=master)](https://dev.azure.com/tpaine154/jupyter/_build/latest?definitionId=13&branchName=master)
        [![GitHub issues](https://img.shields.io/github/issues/timkpaine/jupyterlab_email.svg)]()
        [![Coverage](https://img.shields.io/azure-devops/coverage/tpaine154/jupyter/13/master)](https://dev.azure.com/tpaine154/jupyter/_build?definitionId=13&_a=summary)
        [![PyPI](https://img.shields.io/pypi/l/jupyterlab_email.svg)](https://pypi.python.org/pypi/jupyterlab_email)
        [![PyPI](https://img.shields.io/pypi/v/jupyterlab_email.svg)](https://pypi.python.org/pypi/jupyterlab_email)
        [![npm](https://img.shields.io/npm/v/jupyterlab_email.svg)](https://www.npmjs.com/package/jupyterlab_email)
        
        ![](https://raw.githubusercontent.com/timkpaine/jupyterlab_email/master/docs/example.gif)
        
        ## 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
        ```bash
        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`
        
        ```python3
        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`
        ```python3
        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`
        
        ```python3
        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`
        
        ```python3
        
        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()
        ```
        
        
        
Keywords: jupyter jupyterlab
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Jupyter
Description-Content-Type: text/markdown
Provides-Extra: dev
