paperboy
A web frontend for scheduling Jupyter notebook reports
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- build.yml
- codeql-analysis.yml
- publish.yml
- arch.png
- contributing1.png
- contributing2.png
- contributing3.gif
- contributing4.png
- contributing5.gif
- contributing6.png
- dag.png
- dag_cleanup.png
- dag_init.png
- dag_nbconvert.png
- dag_out.png
- dag_papermill.png
- demo.gif
- job.png
- notebook.png
- notebook_upload.gif
- reports.png
- reports_demo.png
- ss.png
- api.md
- conf.py
- logo.png
- make.bat
- Makefile
- ReportPost-Report-1_11-05-2018_16-38-58.html
- ReportPost-Report-2_11-05-2018_16-38-57.html
- ReportPost-Report-3_11-05-2018_16-39-00.html
- ReportPost-Report-4_11-05-2018_16-39-03.html
- ReportPost-Report-5_11-05-2018_16-39-00.html
- ReportPost-Report-6_11-05-2018_16-39-01.html
- example_dag.py
- params.jsonl
- params_min.jsonl
- requirements.txt
- sample.ipynb
- font-awesome.min.css
- login.css
- fontawesome-webfont.woff
- fonts.css
- mem5YaGs126MiZpBA-UN_r8OUuhs.ttf
- mem5YaGs126MiZpBA-UNirkOUuhs.ttf
- mem8YaGs126MiZpBA-UFVZ0e.ttf
- z7NFdQDnbTkabZAIOl9il_O6KJj73e7Ff0GmDuXMQg.ttf
- z7NFdQDnbTkabZAIOl9il_O6KJj73e7Ff1GhDuXMQg.ttf
- paperboy.jpg
- bundle.js
- perspective.worker.async.js
- perspective.worker.async.js.map
- psp.async.wasm
- 404.html
- index.html
- login.html
- logout.html
- register.html
- README.md
- __init__.py
- application.py
- base.py
- forms.py
- job.py
- notebook.py
- output.py
- README.md
- report.py
- scheduler.py
- storage.py
- user.py
- __init__.py
- auth_required.py
- cors.py
- load_user.py
- multipart.py
- none.py
- README.md
- sqla.py
- __init__.py
- _email.py
- base.py
- local.py
- README.md
- sqla.py
- __init__.py
- autocomplete.py
- base.py
- config.py
- html.py
- job.py
- login.py
- logout.py
- notebook.py
- README.md
- register.py
- report.py
- scheduler.py
- static.py
- status.py
- __init__.py
- common.py
- dokku.py
- nbconvert.py
- papermill.py
- post.py
- voila.py
- __init__.py
- airflow.py
- airflow_login.py
- paperboy.airflow.py
- __init__.py
- __init__.py
- local.py
- schedule.py
- __init__.py
- common.py
- dokku.py
- nbconvert.py
- papermill.py
- post.py
- voila.py
- __init__.py
- luigi.py
- paperboy.luigi.py
- __init__.py
- base.py
- README.md
- remote.py
- __init__.py
- __main__.py
- api.py
- deploy.py
- deploy_nix.py
- deploy_win.py
- README.md
- __init__.py
- base.py
- job.py
- notebook.py
- output.py
- report.py
- user.py
- __init__.py
- base.py
- fixtures.py
- job.py
- notebook.py
- report.py
- user.py
- __init__.py
- base.py
- manager.py
- README.md
- utils.py
- html.tpl
- html_email.tpl
- pdf.tplx
- pdf_license
- __init__.py
- __main__.py
- _nbconvert.py
- _papermill.py
- _virtualenv.py
- README.md
- remote_airflow.py
- __init__.py
- __main__.py
- _version.py
- utils.py
- init_db.sh
- start_dask.sh
- start_dask_worker.sh
- start_db.sh
- start_luigi.sh
- browser.css
- dockpanel.css
- header.css
- index.css
- menu.css
- modal.css
- status.css
- tabbar.css
- vars.css
- autocomplete.ts
- detail.ts
- errors.ts
- form.ts
- index.ts
- loader.ts
- modal.ts
- primary.ts
- status.ts
- common.ts
- generic.ts
- horizontalTable.ts
- index.ts
- input.ts
- label.ts
- listTable.ts
- select.ts
- textarea.ts
- verticalTable.ts
- common.ts
- index.ts
- urls.ts
- browser.ts
- header.ts
- index.ts
- menu.ts
- primary.ts
- status.ts
- define.ts
- index.ts
- main.ts
- assetsTransformer.js
- fileMock.js
- styleMock.js
- image.jpg
- test_cors.py
- test_multipart.py
- test_fixtures.py
- export.test.ts
- test_run.py
- __init__.py
- test_all.py
- test_import.py
- .bumpversion.cfg
- .gitattributes
- .gitignore
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- jest.config.js
- LICENSE
- Makefile
- MANIFEST.in
- package.json
- paperboy.db
- Paperboy_Gameplan.md
- Procfile
- pyproject.toml
- README.md
- setup.cfg
- setup.py
- tsconfig.json
- tslint.json
- webpack.config.js
# Installation Guide
1. Get the code
git clone https://github.com/tkp-archive/paperboy
Downloads the entire project code from GitHub to your computer.
cd paperboy
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Python
EasyPrerequisites
- Jupyter notebooks are an ideal report template, and with [NBConvert](https://github.com/jupyter/nbconvert) support a wide variety of output types, including PDFs, HTML, Emails, etc
Type this command into your terminal and run it.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)