gpgme/lang/python/docs/dita/howto/part02/no-rest.dita
Ben McGinnes f0063afa71 docs: python bindings HOWTO - DITA XML version
* Due to the org-babel bug which breaks Python source code examples
  beyond the most simple snippets, ported the HOWTO to a source format
  which I *know* for sure won't break it.
* Details of the org-mode bug is in https://dev.gnupg.org/T3977
* DITA project uses DITA-OT 2.x (2.4 or 2.5, IIRC) with support for DITA 1.3.
* source files were written with oXygenXML Editor 20.0, hence the
  oXygenXML project file in the directory; however only the .ditamap
  and .dita files are required to generate any output with the
  DITA-OT.

Signed-off-by: Ben McGinnes <ben@adversary.org>
2018-05-15 13:13:16 +10:00

21 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<topic id="topic_wmg_2hy_5db">
<title>No REST</title>
<body>
<p>The first part of which is or will be fairly blatantly obvious upon viewing the first
example, but it's worth reiterating anyway. That being that this API is <b><i>not</i></b> a
REST API. Nor indeed could it ever be one.</p>
<p>Most, if not all, Python programmers (and not just Python programmers) know how easy it is
to work with a RESTful API. In fact they've become so popular that many other APIs attempt
to emulate REST-like behaviour as much as they are able. Right down to the use of JSON
formatted output to facilitate the use of their API without having to retrain
developers.</p>
<p>This API does not do that. It would not be able to do that and also provide access to the
entire C API on which it's built. It does, however, provide a very pythonic interface on top
of the direct bindings and it's this pythonic layer with which this HOWTO deals with.</p>
</body>
</topic>
</dita>