Mac-letterhead 0.2.0

A macOS PDF Service to merge letterhead with printed documents

Mac-letterhead

A macOS PDF Service that automatically merges a letterhead template with printed documents.

Installation

Install the package:

uv pip install -e .

Usage

Installing a Letterhead Service

To create a PDF Service for a specific letterhead template:

uv run mac-letterhead install /path/to/your/letterhead.pdf

This will create a new PDF Service named "Letterhead " in your PDF Services directory.

Using the Letterhead Service

1. Open any document you want to print with the letterhead
2. Choose File > Print
3. Click the PDF dropdown button
4. Select "Letterhead " from the menu
5. Choose where to save the merged PDF

By default, this will generate multiple PDF files with different merging strategies so you can choose the one that works best for your specific letterhead and document.

Using Different Merge Strategies

If you already know which strategy works best for your letterhead, you can specify it directly:

uv run mac-letterhead print /path/to/your/letterhead.pdf "Document Name" "" /path/to/document.pdf --strategy overlay

Available strategies:

• multiply: Original strategy using multiply blend mode
• reverse: Draws content first, then letterhead on top with blend mode
• overlay: Uses overlay blend mode for better visibility
• transparency: Uses transparency layers for better blending
• darken: Uses darken blend mode which works well for light letterheads
• all: (Default) Generates files using all strategies for comparison

Version Information

To check the current version:

uv run mac-letterhead --version

Error Logging

The tool logs all operations and errors to:

~/Library/Logs/Mac-letterhead/letterhead.log

If you encounter any issues while using the tool, check this log file for detailed error messages and stack traces.

Features

• Easy installation of letterhead services
• Supports multiple letterhead templates
• Maintains original PDF metadata
• Preserves PDF quality
• Shows save dialog for output location
• Proper error handling with detailed logging
• Supports --version flag
• Type hints for better code maintainability

Development

To install in development mode:

uv pip install -e .

Publishing a New Release

First-time Setup

1. Create an account on PyPI if you don't have one
2. Create an API token on PyPI:
   • Go to https://pypi.org/manage/account/token/
   • Create a token with "Upload packages" scope
3. Add the token to GitHub repository secrets:
   • Go to your repository's Settings > Secrets and variables > Actions
   • Create a new secret named PYPI_API_TOKEN
   • Paste your PyPI token as the value

Publishing a Release

1. Update the version in:

   • pyproject.toml
   • letterhead_pdf/init.py
   • letterhead_pdf/main.py

2. Run the release script:

./tag_release.sh

This will:

• Create a git tag for the current version
• Push the tag to GitHub
• Trigger the GitHub workflow to publish to PyPI

The GitHub workflow will:

• Build the package
• Upload it to PyPI using the configured API token
• Make it available for installation via pip/uv

Troubleshooting

If you encounter any issues:

1. Check the log file at ~/Library/Logs/Mac-letterhead/letterhead.log
2. The log contains detailed information about:
   • All operations performed
   • Error messages with stack traces
   • Input/output file paths
   • PDF processing steps

License

MIT License