KNITPY(1)

📦 version 0.1.1+git20210425, in debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 KNITPY(1) — General Commands Manual 💖

okay bestie, pull up a chair, we're learning knitpy and honestly? it's giving academic baddie. 🎀

✨ NAME ✨

knitpy — a report generation tool with Python 🐍💅

🌸 SYNOPSIS 🌸

knitpy [options] infile.pymd

🦋 DESCRIPTION 🦋

so basically this app converts pymd documents (*.pymd) into a whole bunch of other formats. glow-up for your files, no cap. ✨

Codeblocks and inline code get executed via IPython kernels, and then the results get inserted straight back into the document. yes, your code runs and your output lands in the doc like it was always meant to be there. main character behaviour fr fr. 👑

Documents should follow rmarkdown syntax (<http://rmarkdown.rstudio.com/>), except you swap 'python' in for 'r' when you want python code to actually execute. iykyk. 🐍

The commandline interface should be compatible with knitr — so if you're coming over from the R side of the internet, you're gonna feel at home. 🫶

knitpy uses pandoc to do any of the file type conversion (md -> html|latex|...). pandoc is the unpaid intern doing all the heavy lifting and honestly? iconic. 💀✨

ONLY SOME FEATURES OF knitr OR rmarkdown ARE YET SUPPORTED... 😭 like, it's a work in progress bestie, be nice to her, she's trying.

🎀 OPTIONS 🎀

Type knitpy --help to see the available options. for more information on full configurables, use --help-all. that's the whole vibe, she'll tell you herself. 💖

🌈 EXAMPLES 🌈

The simplest way to use knitpy is:

knitpy mydocument.pymd

which will convert mydocument.pymd to the default format (probably HTML). easy. effortless. slay. 💅

Output formats supported: 'html', 'pdf' and 'docx'. Change with --to=<format>. 🦋

Use --to=all to convert to all export formats specified in the yaml header. go big or go home, bestie. 🔥

⭐ SEE ALSO ⭐

You can find more information in /usr/share/doc/python3-knitpy/README.md 📖

The project's home page is available at <https://github.com/janschulz/knitpy> 🏠💜

👑 AUTHOR 👑

knitpy was written by Jan Schulz. legend behaviour, honestly. 🫶

This manual page was written by Miriam Ruiz <miriam@debian.org>, for the Debian project (but may be used by others). 💖

okay that's the whole page!! this was written for the General Commands Manual and it's sitting at version 0.1.1 🎀✨ go forth and knit your little heart out, bestie, you're gonna eat 💅🌸🦋

📦 where this page comes from