Python: Internet Printing Protocol (IPP) Client

Asynchronous Python client for Internet Printing Protocol (IPP).

Note: aioipp is a maintained fork of pyipp by Chris Talkington. It keeps the pyipp import name and adds page counter support. It is published on PyPI as aioipp; do not install it alongside pyipp.

About

This package allows you to monitor printers that support the Internet Printing Protocol (IPP) programmatically.

Installation

pip install aioipp

Usage

import asyncio

from pyipp import IPP, Printer


async def main():
    """Show example of connecting to your IPP print server."""
    async with IPP("ipps://EPSON123456.local:631/ipp/print") as ipp:
        printer: Printer = await ipp.printer()
        print(printer)


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Reporting a problem with your printer

Printers vary a lot in how closely they follow the IPP specification. If your printer fails to set up in Home Assistant, or a value looks wrong, the most useful thing you can provide is a raw capture of what the printer sends. The package ships a small diagnostics command for exactly that:

uvx --python 3.14 aioipp ipp://192.168.1.10:631/ipp/print

or, in an environment where the package is already installed:

python -m pyipp ipp://192.168.1.10:631/ipp/print

Use ipps:// if the printer requires TLS, and --ipp-version 1.1 for older devices. The command prints the attributes the library received, what it parsed them into, and a full traceback if parsing failed. It always writes the raw response to ipp-<host>.bin in the current directory.

Then open an issue with:

• the printer make, model and firmware version
• the full output of the command
• the ipp-<host>.bin file (zip it if GitHub refuses the extension)

Serial numbers, UUIDs, hosts and names are masked in both the capture and the output, so they are safe to post. Masking keeps every value the same length, so a masked capture still reproduces the problem. Pass --no-scrub to keep the original values, for example when debugging locally. Captured files become regression tests in tests/fixtures, so they are the fastest route to a fix.

When aioipp fails to parse a response inside another application, such as Home Assistant, the logged error ends with a -----BEGIN SCRUBBED IPP RESPONSE----- block. It holds the same masked capture, compressed and base64 encoded, so pasting the full error into an issue is enough. Maintainers can turn it back into a capture file with:

python -m pyipp --from-log home-assistant.log -o ipp-capture.bin

If you cannot install Python packages, the ipptool command that ships with CUPS on Linux and macOS is a good substitute. Its output is not masked, so remove the serial number, UUIDs and hosts before posting it:

ipptool -tv ipp://192.168.1.10:631/ipp/print get-printer-attributes.test

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.9+
• Poetry
• NodeJS 20+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest