2022-07-28 01:06:46 -07:00
|
|
|
.. SPDX-FileCopyrightText: 2022 James R. Barlow
|
|
|
|
|
..
|
|
|
|
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
|
|
|
|
|
2020-06-30 04:20:14 -07:00
|
|
|
=============
|
2023-10-14 00:45:04 -07:00
|
|
|
API reference
|
2020-06-30 04:20:14 -07:00
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
This page summarizes the rest of the public API. Generally speaking this
|
2023-10-14 00:45:04 -07:00
|
|
|
should be mainly of interest to plugin developers.
|
2020-06-30 04:20:14 -07:00
|
|
|
|
2021-01-26 01:40:40 -08:00
|
|
|
ocrmypdf
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. autoclass:: ocrmypdf.PageContext
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: ocrmypdf.PdfContext
|
|
|
|
|
:members:
|
|
|
|
|
|
2023-10-15 01:14:15 -07:00
|
|
|
.. autoclass:: ocrmypdf.Verbosity
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
|
|
|
|
|
.. autofunction:: ocrmypdf.configure_logging
|
|
|
|
|
|
|
|
|
|
.. autofunction:: ocrmypdf.ocr
|
|
|
|
|
|
|
|
|
|
.. autofunction:: ocrmypdf.pdf_to_hocr
|
|
|
|
|
|
|
|
|
|
.. autofunction:: ocrmypdf.hocr_to_ocr_pdf
|
|
|
|
|
|
2020-06-30 04:20:14 -07:00
|
|
|
ocrmypdf.exceptions
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.exceptions
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
|
|
|
|
|
ocrmypdf.helpers
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.helpers
|
|
|
|
|
:members:
|
2021-01-26 01:40:40 -08:00
|
|
|
:noindex: deprecated
|
|
|
|
|
|
|
|
|
|
.. autodecorator:: deprecated
|
2020-06-30 04:20:14 -07:00
|
|
|
|
|
|
|
|
ocrmypdf.hocrtransform
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.hocrtransform
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
ocrmypdf.pdfa
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.pdfa
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
ocrmypdf.quality
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.quality
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
ocrmypdf.subprocess
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
.. automodule:: ocrmypdf.subprocess
|
|
|
|
|
:members:
|
