pandocmk 0.2.1

Last updated:

0 purchases

pandocmk 0.2.1 Image
pandocmk 0.2.1 Images
Add to Cart

Description:

pandocmk 0.2.1

pandocmk: a minmalist make tool for Pandoc
Writers of complex Pandoc documents often run into three issues:

Very long command-line options that they need to remember (or copy-paste) all the time
Need for extensibility, which can be mostly solved via filters (at the cost of #1)
Pre/post processing tools, which can be solved via more complex one-liners (pandoc ... && SumatraPDF output.pdf && ...)

The goal of pandocmk is to simplify using Pandoc, by helping with #1 and a little bit with #3 (#2 is covered by e.g. panflute). It uses information from the YAML metadata field to build the command-line arguments, and also has extra arguments for extras I find useful (such as monitoring a file and auto-building as needed, auto-viewing in a PDF viewer, etc.).
Existing tools
There are several good existing tools:

pandocomatic (Ruby)
panrun (Ruby; powers panwriter)
rmarkdown (R; powers bookdown and RStudio)
panzer (Python; inactive)

However, they don't completely fill my needs, which leads to this package.
Usage
pandocmk has a few custom command-line options. Everything else is forwarded to Pandoc (and overrides whatever is set in the YAML metadata). Thus, in practice this is just a Pandoc wrapper with a few extras.
pandocmk [OPTIONS] [FILES]
--view open output file in a viewer such as SumatraPDF for .pdf
--watch monitor the input files for changes, and rebuild as needed
--tex save .tex output besides .pdf
--timeit show build time
--verbose show debugging information

--draft NOT IMPLEMENTED.
When building a Latex PDF, choose faster options (pdflatex, etc)

Note: other options are passed to Pandoc

Installation
To install pandocmk, open the command line and type:
pip install pandocmk

Note: pandocmk requires Python 3.7 or higher.
Uninstall
pip uninstall pandocmk

Dev Install
After cloning the repo and opening the pandocmk folder:
python setup.py install: install the package locally
python setup.py develop: install locally with a symlink so changes are automatically updated
Dev Update PyPI:
python setup.py sdist bdist_wheel
python -m twine upload dist/*

(Ensure README.md has unix line endings)
Roadmap

v0.1: use the pandoc metadata to build the CLI arguments
v0.2: add support for the --view and --watch options
v0.3: tweaks based on what we learned so far
v0.4: add support for styles (should we name them output, defaults, etc.?)

License:

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Files In This Product:

Customer Reviews

There are no reviews.