pandoctylus 0.1.0

A crazy and opinionated way of generating documents.

Pandoctylus

A crazy and opinionated way of generating documents.

Installation

pip install pandoctylus

Use

Check out the example project in examples/project1 to understand how to make a document. Key ingredients:

• define the document as yaml file in docs/ sub-dir
• create or pick an existing jinja template and refernece it in the yaml file
• create or pick an existing docx template and reference it in the yaml file
• run the tool: python pandoctylus/pandoctylus.py --root-dir examples/project1
• enjoy the generated docs in examples/project1/output

Development

This project uses modern Python packaging with pyproject.toml. To set up the development environment:

1. Clone the repository:

git clone https://github.com/yourusername/pandoctylus.git
cd pandoctylus

2. Create a virtual environment and install development dependencies:

uv venv pandoctylus-venv
source .pandoctylus-venv/bin/activate 
uv pip install -e ".[dev]"

3. Run tests:

pytest

Features

• Generate multiple documents from shared Markdown and YAML and a docx template.

License

MIT License