PyZim API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Module Index

  • pyzim - pyzim - python library for working with ZIM files.
    • archive - This module contains the top-level archive object, which provides the main API.
    • bindable - Mix-in for binding objects to the Archive.
    • blob - Classes for working with blobs (content of entries).
    • cache - Various cache strategies.
    • cluster - Implementation of clusters.
    • compression - This module contains functionality related to compression.
    • compressionstrategy - The compression strategy handles the bundling of blobs into clusters.
    • constants - This module contains various constants.
    • counter - This module implements the counter, which is responsible for the MCounter metadata.
    • entry - Implementation of entries.
    • exceptions - Exception definitions.
    • header - This module contains the class for working with ZIM headers.
    • item - This module contains the Item class, which is a helper for easily adding entries with blobs.
    • mimetypelist - Implementation of the MIME type list.
    • modifiable - Mix-in for modifiable objects in an archive.
    • operationbuffer - This module contains the pyzim.operationbuffer.OperationBuffer class.
    • pointerlist - Implementation of URL and title pointer lists.
    • policy - Policies for class behavior.
    • processor - Processors provide a way to monitor and manipulate various events and actions happening in a ZIM archive.
    • search - Search and suggestion logic.
    • spaceallocator - This module contains functionality for managing the space inside a file.
    • util - This subpackage contains various utility functions, both functions for internal use and convenience utilities for users.
      • ioutil - Various I/O related utility functions.
      • iter - Iteration utilities.
      • translator - Utilities for applying changes to an entire ZIM file.
API Documentation for PyZim, generated by pydoctor 25.10.1 at 2026-01-21 22:55:25.