{"id":15292586,"url":"https://github.com/nbprint/nbprint","last_synced_at":"2026-02-23T09:11:58.591Z","repository":{"id":37965847,"uuid":"206466514","full_name":"nbprint/nbprint","owner":"nbprint","description":"A framework for building print-oriented media with Jupyter","archived":false,"fork":false,"pushed_at":"2025-04-13T05:21:05.000Z","size":20333,"stargazers_count":33,"open_issues_count":8,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-13T12:13:33.611Z","etag":null,"topics":["html","jupyter","jupyter-notebook","nbconvert","pagedjs","pdf","print-media","reporting","reports"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nbprint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-05T03:27:06.000Z","updated_at":"2025-04-12T16:01:30.000Z","dependencies_parsed_at":"2024-01-11T20:32:06.935Z","dependency_job_id":"fe04ad14-2d4d-43af-9e4a-14f6d02b774c","html_url":"https://github.com/nbprint/nbprint","commit_stats":{"total_commits":66,"total_committers":2,"mean_commits":33.0,"dds":0.09090909090909094,"last_synced_commit":"0cc053ff5d514ef4430cd19baf5340faaaf9de11"},"previous_names":["timkpaine/nbcx","nbprint/nbprint","timkpaine/nbprint"],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbprint%2Fnbprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbprint%2Fnbprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbprint%2Fnbprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbprint%2Fnbprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nbprint","download_url":"https://codeload.github.com/nbprint/nbprint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710448,"owners_count":21149191,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html","jupyter","jupyter-notebook","nbconvert","pagedjs","pdf","print-media","reporting","reports"],"created_at":"2024-09-30T16:18:57.153Z","updated_at":"2026-02-23T09:11:58.585Z","avatar_url":"https://github.com/nbprint.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca class=\"logo-light\" href=\"https://github.com/nbprint/nbprint#gh-light-mode-only\"\u003e\n  \u003cimg src=\"https://github.com/nbprint/nbprint/raw/main/docs/img/logo-light.png?raw=true#gh-light-mode-only\" alt=\"nbprint\" width=\"400\"\u003e\u003c/a\u003e\n\u003c/a\u003e\n\u003ca class=\"logo-dark\" href=\"https://github.com/nbprint/nbprint#gh-dark-mode-only\"\u003e\n  \u003cimg src=\"https://github.com/nbprint/nbprint/raw/main/docs/img/logo-dark.png?raw=true#gh-dark-mode-only\" alt=\"nbprint\" width=\"400\"\u003e\u003c/a\u003e\n\u003c/a\u003e\n\u003cbr/\u003e\n\nA framework for building print media with [`nbconvert`](https://nbconvert.readthedocs.io).\n\n[![Build Status](https://github.com/nbprint/nbprint/actions/workflows/build.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/nbprint/nbprint/actions/workflows/build.yaml)\n[![Coverage](https://codecov.io/gh/nbprint/nbprint/branch/main/graph/badge.svg?token=ag2j2TV2wE)](https://app.codecov.io/gh/nbprint/nbprint/tree/main)\n[![GitHub issues](https://img.shields.io/github/issues/nbprint/nbprint.svg)](https://github.com/nbprint/nbprint/issues)\n[![License](https://img.shields.io/github/license/nbprint/nbprint)](https://github.com/nbprint/nbprint)\n\n## Background\n\nJupyter Notebooks are widely used for reports via [`nbconvert`](https://nbconvert.readthedocs.io/en/latest/), but most development work has been on enabling building interactive websites. The goal of `nbprint` is to focus on print-oriented workflows, e.g. PDF, by leveraging new developments in `nbconvert` and the [`pagedjs`](https://pagedjs.org) print-oriented layout library.\n\nFor a deeper dive, see [the documentation](https://nbprint.github.io/nbprint/index.html).\n\n## Quickstart\n\n`nbprint` provides an `nbconvert` template and a [configuration framework](https://nbprint.github.io/nbprint/docs/src/configuration.html).\nThe simplest example can be run with defaults by calling the `nbprint` executable on an existing notebook:\n\n```bash\nnbprint examples/basic.ipynb\n```\n\nThis CLI supports configuration-driven customization with [hydra](https://hydra.cc) syntax:\n\n```bash\nnbprint examples/basic.ipynb +nbprint.name=test ++nbprint.outputs.target=pdf\n\n# First cell is papermill-style parameters\nnbprint examples/parameters.ipynb +nbprint.parameters.a=test\n\n# Overlay a config group, e.g. title and table of contents\nnbprint examples/basic.ipynb nbprint/content/frontmatter=nbprint/title_toc\n```\n\n```mermaid\ngraph TB\n    nb(\"notebook\u003cbr\u003e(.ipynb)\")\n    nbc{nbconvert}\n    nbct[/nbprint \u003cbr\u003e template/]\n    pjs[/paged.js \u003cbr\u003e layout engine/]\n    o@{ shape: doc, label: \"output (html,pdf,etc)\" }\n\n    nb e2@---\u003enbc\n    e2@{animate: true}\n\n    nbct --\u003e nbc\n    pjs --- nbct\n\n    nbc e3@--\u003eo\n    e3@{animate: true}\n```\n\nFor more information, see [the architecture documentation](https://nbprint.github.io/nbprint/docs/src/architecture.html).\n\n### Configuration\n\nSee the [configuration framework documentation](https://nbprint.github.io/nbprint/docs/src/configuration.html) for more information on building pure YAML-based report workflows with `hydra`.\n\n## Installation\n\nInstall with `pip`:\n\n```bash\npip install nbprint\n```\n\nInstall with `conda`\n\n```bash\nconda install nbprint -c conda-forge\n```\n\n## Development\n\n**Warning**: This project is under active development, so all APIs are subject to change!\n\n## License\n\nThis software is licensed under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.\n\n\u003e [!NOTE]\n\u003e This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbprint%2Fnbprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnbprint%2Fnbprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbprint%2Fnbprint/lists"}