Git Product home page Git Product logo

paperboy's Introduction

paperboy

Status

A web frontend for scheduling Jupyter Notebooks as reports

Overview

Build Status https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true Waffle.io 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

Storage Arch

Parameters demo

Airflow Integration

paperboy's People

Contributors

timkpaine avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.