summaryrefslogtreecommitdiffstats
path: root/doc/source/library/index.rst
blob: 0b048c805e7fa986ff069abf8acdd96f506f479a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Python APT Library
==================
Python APT's library provides access to almost every functionality supported
by the underlying apt-pkg and apt-inst libraries. This means that it is
possible to rewrite frontend programs like apt-cdrom in Python, and this is
relatively easy, as can be seen in e.g. :doc:`../tutorials/apt-cdrom`.

When going through the library, the first two modules are :mod:`apt_pkg` and
:mod:`apt_inst`. These modules are more or less straight bindings to the
apt-pkg and apt-inst libraries and the base for the rest of python-apt.

Going forward, the :mod:`apt` package appears. This package is using
:mod:`apt_pkg` and :mod:`apt_inst` to provide easy to use ways to manipulate
the cache, fetch packages, or install new packages. It also provides useful
progress classes, currently only for text interfaces. The last package is
:mod:`aptsources`. The aptsources package provides classes and functions to
read files like :file:`/etc/apt/sources.list` and to modify them.

.. toctree::
    :maxdepth: 1

    apt_pkg
    apt_inst

    apt.cache
    apt.cdrom
    apt.debfile
    apt.package
    apt.progress.base
    apt.progress.text

    aptsources.distinfo
    aptsources.distro
    aptsources.sourceslist