API reference

This is the API reference for pyHanko, compiled from the docstrings present in the Python source files. For a more high-level overview, see the library user guide. If you are interested in using pyHanko as a command-line application, please refer to the CLI user guide.

Warning

Any function, class or method that is not covered by this documentation is considered private API by definition.

Until pyHanko goes into beta, any part of the API is subject to change without notice, but this applies doubly to the undocumented parts. Tread with caution.

• pyhanko package
  • Subpackages
    • pyhanko.pdf_utils package
      • pyhanko.pdf_utils.barcodes module
      • pyhanko.pdf_utils.config_utils module
      • pyhanko.pdf_utils.content module
      • pyhanko.pdf_utils.crypt module
      • pyhanko.pdf_utils.embed module
      • pyhanko.pdf_utils.filters module
      • pyhanko.pdf_utils.font package
      • pyhanko.pdf_utils.generic module
      • pyhanko.pdf_utils.images module
      • pyhanko.pdf_utils.incremental_writer module
      • pyhanko.pdf_utils.layout module
      • pyhanko.pdf_utils.misc module
      • pyhanko.pdf_utils.reader module
      • pyhanko.pdf_utils.rw_common module
      • pyhanko.pdf_utils.text module
      • pyhanko.pdf_utils.writer module
    • pyhanko.sign package
      • pyhanko.sign.ades package
      • pyhanko.sign.beid module
      • pyhanko.sign.diff_analysis module
      • pyhanko.sign.fields module
      • pyhanko.sign.general module
      • pyhanko.sign.pkcs11 module
      • pyhanko.sign.signers package
      • pyhanko.sign.timestamps module
      • pyhanko.sign.validation module
  • Submodules
    • pyhanko.config module
    • pyhanko.stamp module