API documentation
=================

The following documentation is based on the source code of version |release|
of the `deb-pkg-tools` package. The following modules are available:

.. contents::
   :local:

.. note:: Most of the functions defined by `deb-pkg-tools` depend on external
   programs. If these programs fail unexpectedly (end with a nonzero exit code)
   :exc:`executor.ExternalCommandFailed` is raised.

:mod:`deb_pkg_tools.cache`
--------------------------

.. automodule:: deb_pkg_tools.cache
   :members:

:mod:`deb_pkg_tools.checks`
---------------------------

.. automodule:: deb_pkg_tools.checks
   :members:

:mod:`deb_pkg_tools.cli`
------------------------

.. automodule:: deb_pkg_tools.cli
   :members:

:mod:`deb_pkg_tools.config`
---------------------------

.. automodule:: deb_pkg_tools.config
   :members:

:mod:`deb_pkg_tools.control`
----------------------------

.. automodule:: deb_pkg_tools.control
   :members:

:mod:`deb_pkg_tools.deb822`
---------------------------

.. automodule:: deb_pkg_tools.deb822
   :members:

:mod:`deb_pkg_tools.deps`
-------------------------

.. automodule:: deb_pkg_tools.deps
   :members:

:mod:`deb_pkg_tools.gpg`
------------------------

.. automodule:: deb_pkg_tools.gpg
   :members:

:mod:`deb_pkg_tools.package`
----------------------------

.. automodule:: deb_pkg_tools.package
   :members:

:mod:`deb_pkg_tools.repo`
-------------------------

.. automodule:: deb_pkg_tools.repo
   :members:

:mod:`deb_pkg_tools.utils`
--------------------------

.. automodule:: deb_pkg_tools.utils
   :members:

:mod:`deb_pkg_tools.version`
----------------------------

.. automodule:: deb_pkg_tools.version
   :members:


:mod:`deb_pkg_tools.version.native`
-----------------------------------

.. automodule:: deb_pkg_tools.version.native
   :members: