dakweb/__init__.py

   1 """
   2 General
   3 =======
   4   The Debian Archive Kit web api, AKA the B{FTP-Master api}, allows
   5   anyone to query the database of the Debian archive kit for information
   6   related to the archive. That is, it provides information about the
   7   archive, its suites and all the packages.
   8
   9   Development
  10   -----------
  11   B{NOTE}: B{The api} is still new and we are adding new features
  12   whenever someone asks for them. Or better yet, provides a patch.
  13   B{The api}s code lives in the C{dak} codebase, if you want to provide
  14   a patch with a new feature, or fix a bug, feel free to clone it::
  15    git clone https://ftp-master.debian.org/git/dak.git
  16
  17   Patches, Feature requests, bug reports go to the
  18   U{debian-dak<mailto:debian-dak@lists.debian.org>}
  19   mailing list.
  20
  21 Usage
  22 =====
  23   B{The api} responds to simple http queries and (usually) replies with
  24   JSON formatted data. Some commands may require an extra parameter to
  25   output JSON (notably the madison one).
  26
  27   U{https://api.ftp-master.debian.org/} is the base path for all
  28   requests.
  29
  30   Available Methods
  31   -----------------
  32   The list of available methods can be seen by browsing the
  33   automatically generated documentation for the L{dakweb.queries}
  34   module. There are various submodules dealing with different parts of
  35   the api. Every I{public} function of those modules corresponds to
  36   one available method. The input parameters and the output format are
  37   documented with each of those functions.
  38
  39
  40 @contact: "Debian FTPMaster <ftpmaster@debian.org>".
  41 """