Skip to main content

A macOS PDF Service to merge letterhead with printed documents

Project description

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

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:
  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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mac_letterhead-0.1.3.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mac_letterhead-0.1.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file mac_letterhead-0.1.3.tar.gz.

File metadata

  • Download URL: mac_letterhead-0.1.3.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for mac_letterhead-0.1.3.tar.gz
Algorithm Hash digest
SHA256 4c9a886fea908328d106124d7ce88c70b661ebf873ef3e8160eb76e66b5254ca
MD5 ab185a991c6b65a8bf670d9d7afa1dc4
BLAKE2b-256 47cc02fb675d4803d34ce1c6b1457d1fe8c92027433c1438b5008acc7847630e

See more details on using hashes here.

File details

Details for the file mac_letterhead-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: mac_letterhead-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for mac_letterhead-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a4039d2f3d5a001b681243ec7fd1d6e62ba137dbe9773898c2813655d191ee7f
MD5 68a8702acdd53a7b376dd4f74eadc1b4
BLAKE2b-256 523d4b36950a9e01b0692c6c6927f4576ab4256ee6d0172a49c1f60bba1cfa40

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page