# plaited 🪢
[](https://github.com/jacobwhall/plaited/actions/workflows/test-with-coverage.yml)
[](https://coveralls.io/github/jacobwhall/plaited?branch=trunk)
plaited is a [Pandoc](https://pandoc.org/) [filter](https://pandoc.org/filters.html) that uses [Jupyter](https://jupyter.org/) [kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) to generate code notebooks.
It's a flexible tool for publishing documents that include code execution in a variety of languages and formats.
It is a fork of [Knitty](https://github.com/kiwi0fruit/knitty), which is a fork of [Stitch](https://github.com/pystitch/stitch), which used code from [knitpy](https://github.com/jankatins/knitpy) and [nbconvert](https://github.com/jupyter/nbconvert).
## Installation
plaited is available on TestPyPI:
```
pip install -i https://test.pypi.org/simple/ plaited
```
I will publish it to PyPI once it is more mature.
## Getting Started
plaited is plug-and-play with Pandoc:
```bash
pandoc --filter plaited -o out.html input.md
```
## Motivation
_Why another code notebook generator?_
Ultimately, plaited is a personal project that I work on for my own benefit.
After reading about Codebraid, Stitch, and Knitty, I wanted a similar tool that meets the following criteria:
### Pandoc filter
- embrace Pandoc AST, allowing other filters, templates, or Pandoc itself to make any formatting decisions
- use [Panflute](https://github.com/sergiocorreia/panflute) to manage document elements
### Jupyter client
- embrace [Jupyter kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) as the means of code execution
- use [Jupyter Client](https://github.com/jupyter/jupyter_client) to interface with the kernels
### modern Python package
- aim to write hackable, maintainable code
- use modern setuptools configuration
## Contributing
You are more than welcome to submit a pull request to this repository, or open an issue, or send me an email…I'd love to hear from you!
## Thanks
plaited builds upon the work of hundreds of people! Here are a handful of them:
- [John MacFarlane](https://johnmacfarlane.net/) and other contributors to [Pandoc](https://pandoc.org/)
- [Sergio Correia](http://scorreia.com/) and other contributors to [Panflute](https://github.com/sergiocorreia/panflute)
- [Tom Augspurger](https://github.com/TomAugspurger), who wrote [Stitch](https://github.com/pystitch/stitch)
- [Peter Zagubisalo](https://github.com/kiwi0fruit), who created [Knitty](https://github.com/kiwi0fruit/knitty)
- [Jan Katins](https://www.katzien.de/en/), who wrote [knitpy](https://github.com/jankatins/knitpy)
Similar tools that influenced this project:
- [Knitr](https://yihui.org/knitr/) by [Yihui Xie](https://yihui.org/)
- [Codebraid](https://github.com/gpoore/codebraid) by [Geoffrey M. Poore](https://gpoore.github.io/)
- [pandoc-plot](https://laurentrdc.github.io/pandoc-plot/) by [Laurent P. René de Cotret](https://laurentrdc.xyz/)
- [Jupyter Book](https://jupyterbook.org/intro.html)
## License
There seems to have been a misunderstanding by previous developers of this project regarding license compatibility.
[Stitch](https://github.com/pystitch/stitch) and [Knitty](https://github.com/kiwi0fruit/knitty), by Tom Augspurger and Peter Zagubisalo respectively, were released using the [MIT License](https://en.wikipedia.org/wiki/MIT_License).
Their code is adapted from the [knitpy](https://github.com/jankatins/knitpy) and [IPython](https://github.com/ipython/ipython) projects, both released under BSD licenses.
I am not a lawyer, but I do not believe that BSD licenses are compatible with the MIT license.
I hope that by relicensing this project under the Modified (3-Clause) BSD License, work by all prior contributors is being used according to their original licenses.
This is not legal advice, and I welcome any feedback regarding the licensure of this repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/jacobwhall/plaited",
"name": "plaited",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pandoc,jupyter,notebook",
"author": "Jacob Hall",
"author_email": "email@jacobhall.net",
"download_url": "https://files.pythonhosted.org/packages/de/f6/506da0bcbe0f2050e5e0941d42e840e0b9ac0839d2116538e67c23e10eb5/plaited-0.0.1.tar.gz",
"platform": null,
"description": "# plaited \ud83e\udea2\n[](https://github.com/jacobwhall/plaited/actions/workflows/test-with-coverage.yml)\n[](https://coveralls.io/github/jacobwhall/plaited?branch=trunk)\n\nplaited is a [Pandoc](https://pandoc.org/) [filter](https://pandoc.org/filters.html) that uses [Jupyter](https://jupyter.org/) [kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) to generate code notebooks.\nIt's a flexible tool for publishing documents that include code execution in a variety of languages and formats.\nIt is a fork of [Knitty](https://github.com/kiwi0fruit/knitty), which is a fork of [Stitch](https://github.com/pystitch/stitch), which used code from [knitpy](https://github.com/jankatins/knitpy) and [nbconvert](https://github.com/jupyter/nbconvert).\n\n## Installation\n\nplaited is available on TestPyPI:\n\n```\npip install -i https://test.pypi.org/simple/ plaited\n```\n\nI will publish it to PyPI once it is more mature.\n\n## Getting Started\n\nplaited is plug-and-play with Pandoc:\n\n```bash\npandoc --filter plaited -o out.html input.md\n```\n\n## Motivation\n\n_Why another code notebook generator?_\n\nUltimately, plaited is a personal project that I work on for my own benefit.\nAfter reading about Codebraid, Stitch, and Knitty, I wanted a similar tool that meets the following criteria:\n\n### Pandoc filter\n\n- embrace Pandoc AST, allowing other filters, templates, or Pandoc itself to make any formatting decisions\n- use [Panflute](https://github.com/sergiocorreia/panflute) to manage document elements\n\n### Jupyter client\n\n- embrace [Jupyter kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) as the means of code execution\n- use [Jupyter Client](https://github.com/jupyter/jupyter_client) to interface with the kernels\n\n### modern Python package\n\n- aim to write hackable, maintainable code\n- use modern setuptools configuration\n\n## Contributing\n\nYou are more than welcome to submit a pull request to this repository, or open an issue, or send me an email\u2026I'd love to hear from you!\n\n## Thanks\n\nplaited builds upon the work of hundreds of people! Here are a handful of them:\n\n- [John MacFarlane](https://johnmacfarlane.net/) and other contributors to [Pandoc](https://pandoc.org/)\n- [Sergio Correia](http://scorreia.com/) and other contributors to [Panflute](https://github.com/sergiocorreia/panflute)\n- [Tom Augspurger](https://github.com/TomAugspurger), who wrote [Stitch](https://github.com/pystitch/stitch)\n- [Peter Zagubisalo](https://github.com/kiwi0fruit), who created [Knitty](https://github.com/kiwi0fruit/knitty)\n- [Jan Katins](https://www.katzien.de/en/), who wrote [knitpy](https://github.com/jankatins/knitpy)\n\nSimilar tools that influenced this project:\n\n- [Knitr](https://yihui.org/knitr/) by [Yihui Xie](https://yihui.org/)\n- [Codebraid](https://github.com/gpoore/codebraid) by [Geoffrey M. Poore](https://gpoore.github.io/)\n- [pandoc-plot](https://laurentrdc.github.io/pandoc-plot/) by [Laurent P. Ren\u00e9 de Cotret](https://laurentrdc.xyz/)\n- [Jupyter Book](https://jupyterbook.org/intro.html)\n\n## License\n\nThere seems to have been a misunderstanding by previous developers of this project regarding license compatibility.\n[Stitch](https://github.com/pystitch/stitch) and [Knitty](https://github.com/kiwi0fruit/knitty), by Tom Augspurger and Peter Zagubisalo respectively, were released using the [MIT License](https://en.wikipedia.org/wiki/MIT_License).\nTheir code is adapted from the [knitpy](https://github.com/jankatins/knitpy) and [IPython](https://github.com/ipython/ipython) projects, both released under BSD licenses.\nI am not a lawyer, but I do not believe that BSD licenses are compatible with the MIT license.\nI hope that by relicensing this project under the Modified (3-Clause) BSD License, work by all prior contributors is being used according to their original licenses.\nThis is not legal advice, and I welcome any feedback regarding the licensure of this repository.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Publish reproducible code notebooks using pandoc and jupyter kernels",
"version": "0.0.1",
"split_keywords": [
"pandoc",
"jupyter",
"notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9662c4a2d0d1509010e6ea937e54b3e2a80322d8b8ea18eb7687a3f21fd4dc68",
"md5": "1a2cbb71ad52890f13abec9997d9dd48",
"sha256": "d23413e23cd7b05022b29a0880ee8c9e7c130230986d1780240a9ce7200690bf"
},
"downloads": -1,
"filename": "plaited-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a2cbb71ad52890f13abec9997d9dd48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11487,
"upload_time": "2023-02-11T06:25:58",
"upload_time_iso_8601": "2023-02-11T06:25:58.524835Z",
"url": "https://files.pythonhosted.org/packages/96/62/c4a2d0d1509010e6ea937e54b3e2a80322d8b8ea18eb7687a3f21fd4dc68/plaited-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "def6506da0bcbe0f2050e5e0941d42e840e0b9ac0839d2116538e67c23e10eb5",
"md5": "3f31617563f28bcf3710fd15b2182fd9",
"sha256": "a2ea2da84ae99497a88ce763ef5e2e8ba78638645a987d1b4f984656f11e5d05"
},
"downloads": -1,
"filename": "plaited-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3f31617563f28bcf3710fd15b2182fd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13730,
"upload_time": "2023-02-11T06:25:59",
"upload_time_iso_8601": "2023-02-11T06:25:59.942320Z",
"url": "https://files.pythonhosted.org/packages/de/f6/506da0bcbe0f2050e5e0941d42e840e0b9ac0839d2116538e67c23e10eb5/plaited-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-11 06:25:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jacobwhall",
"github_project": "plaited",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "plaited"
}
JSON
