protocol-formatter 0.1.3

A utility to format raw text protocols into styled PDFs

# 🧾 Protocol Formatter

Format raw text protocols into clean, publish-ready Word and pdf documents
Say goodbye to messy indentation, unclear bulleting, and formatting inconsistency in step-by-step protocols.

---

---

✨ Features

• Automatically detects stepwise sections in .txt protocols
• Adds clean spacing between blocks
• Handles blank lines, indents, and bullet lists
• Formats output to a well-structured .docx document
• Output file uses the same name as input (with .docx extension)
• Fully local and fast

---

📦 Installation

pip install protocol_formatter

Note for macOS/Linux users:
This package relies on system-level libraries like Cairo, Pango, and GDK-Pixbuf for converting .docx to .pdf.
Make sure to install them using:

brew install cairo pango gdk-pixbuf libffi  # macOS
sudo apt install libcairo2 libpango-1.0-0 libgdk-pixbuf2.0-0 libffi-dev  # Debian/Ubuntu

---

🧪 How to Use

protocol_formatter path/to/input_protocol.txt

• You’ll be prompted to provide a path if not passed as argument.
• Output will be saved as a .docx file in the same folder.

---

📂 Input Format

Supports .txt files containing stepwise procedures like:

- Prepare solutions
* Mix reagents...
* Adjust pH...
** nested content

- Sample Treatment
* Add buffer
* Incubate at 37°C

---

🖨 Sample Output

A fully formatted DOCX output example:

---

🛠 Developer Notes

• Entry point defined in __init__.py
• Uses python-docx for Word file creation
• Compatible with Python 3.7+

---

📜 License

Licensed under the MIT License. See LICENSE for details.