Skip to main content

Jupyter notebooks

Project description

paperboy

Status

A web frontend for scheduling Jupyter Notebooks as reports

Overview

Build Status https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true Coverage Docs Site

Paperboy is a production-grade application for scheduling reports. It has a flexible architecture and extensible APIs, and can integrate into a wide variety of deployments. It is composed of various industrial-strength technologies from the open source world.

  • Jupyter Notebooks for the reports themselves
    • Jupyter notebooks are an ideal report template, and with NBConvert support a wide variety of output types, including PDFs, HTML, Emails, etc
  • Papermill to parameterize notebooks
  • SQLAlchemy for Storage (default)
  • Apache Airflow for Scheduling (default)
  • PhosphorJS for the frontend
  • Support for Python Virtualenvs via requirements.txt or custom Docker images via Dockerfiles on a per-notebook level
  • Traitlets parameterization of storage and scheduler classes for easy integration with custom storage backends and custom schedulers
  • Single click notebook deployment with Voila and Dokku

Process Flow

  • Upload notebook
  • Configure job
    • start time
    • interval
    • papermill parameters to autoconfigure reports
    • if autoconfiguring reports from papermill:
      • run or publish
      • output
        • notebook
        • pdf
        • html
        • email
        • script
      • strip or keep code
  • To edit or create additional reports on a job, configure reports
    • run or publish
    • output
      • notebook
      • pdf
      • html
      • email
      • script
    • strip or keep code

Installation from source

Paperboy requires Python and Node.js, which can be installed from conda-forge if conda is available.

Clone the repository and run following commands to install and launch the application:

  • npm install
  • npm run build
  • pip install -e .
  • python -m paperboy

Visit http://0.0.0.0:8080 in a browser to view the application.

The default authentication backend requires the registration of a username that can be used on subsequent launches.

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

jupyter_paperboy-0.1.1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

jupyter_paperboy-0.1.1-py2.py3-none-any.whl (1.5 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file jupyter_paperboy-0.1.1.tar.gz.

File metadata

  • Download URL: jupyter_paperboy-0.1.1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for jupyter_paperboy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 32f9b5605190e3e1d622f6852c673a030bdc1abf82ef951ef965c302c8d60692
MD5 c12c72e655bf8a93e5dea8be660eb1b2
BLAKE2b-256 f717009d0539a8d709ae2d92ac4831c54a0742afb363bb3ee8e9a1abf70bca01

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_paperboy-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: jupyter_paperboy-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for jupyter_paperboy-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9137fb8069f6c3276b6029a7ac85da6b2d597e94432efff52cb989cb7d25e74d
MD5 4e573fac0cfe2a5a3e05e2edd0668231
BLAKE2b-256 ca0f3e74cee361aeef55b7572f29bb7ef5d63d257a5129d15dbf62bdb9272691

See more details on using hashes here.

Provenance

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