docs: python bindings examples
authorBen McGinnes <ben@adversary.org>
Mon, 19 Mar 2018 21:26:57 +0000 (08:26 +1100)
committerBen McGinnes <ben@adversary.org>
Mon, 19 Mar 2018 21:26:57 +0000 (08:26 +1100)
* Added reference to location where all the examples included in the
  HOWTO will be available as executable scripts.
* Included a short README file in that location.

lang/python/docs/GPGMEpythonHOWTOen.org
lang/python/examples/howto/README.org [new file with mode: 0644]

index b364b51..770c278 100644 (file)
@@ -1,4 +1,4 @@
-#+TITLE: GNU Privacy Guard (GnuPG)  Made Easy Python Bindings HOWTO (English)
+#+TITLE: GNU Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO (English)
 #+LATEX_COMPILER: xelatex
 #+LATEX_CLASS: article
 #+LATEX_CLASS_OPTIONS: [12pt]
    data types with which GPGME deals considerably easier.
 
 
+** Examples
+   :PROPERTIES:
+   :CUSTOM_ID: howto-python3-examples
+   :END:
+
+   All of the examples found in this document can be found as Python 3
+   scripts in the =lang/python/examples/howto= directory.
+
+
 * GPGME Concepts
   :PROPERTIES:
   :CUSTOM_ID: gpgme-concepts
diff --git a/lang/python/examples/howto/README.org b/lang/python/examples/howto/README.org
new file mode 100644 (file)
index 0000000..ee8c986
--- /dev/null
@@ -0,0 +1,24 @@
+#+TITLE: GPGME Python Bindings HOWTO Examples
+#+LATEX_COMPILER: xelatex
+#+LATEX_CLASS: article
+#+LATEX_CLASS_OPTIONS: [12pt]
+#+LATEX_HEADER: \usepackage{xltxtra}
+#+LATEX_HEADER: \usepackage[margin=1in]{geometry}
+#+LATEX_HEADER: \setmainfont[Ligatures={Common}]{Times New Roman}
+#+LATEX_HEADER: \author{Ben McGinnes <ben@gnupg.org>}
+
+
+* Examples
+  :PROPERTIES:
+  :CUSTOM_ID: gpgme-python3-examples
+  :END:
+
+  The contents of this directory are the examples included in the /GNU
+  Privacy Guard (GnuPG) Made Easy Python Bindings HOWTO/ file.  Each
+  script is explicitly for Python 3 and specifically for Python 3.4 or
+  later.
+
+  Some of these scripts may work with Python 2.7, but there are no
+  guarantees.  They will include the relevant imports from the
+  =__future__= module to facilitate that if possible.
+