examples: python bindings and hkp4py updates
authorBen McGinnes <ben@adversary.org>
Sun, 23 Sep 2018 01:43:34 +0000 (11:43 +1000)
committerBen McGinnes <ben@adversary.org>
Sun, 23 Sep 2018 01:43:34 +0000 (11:43 +1000)
* Mostly tightening up the details on the hkp4py example script.
* Also fixed a typo in the LGPL boiler plate text included in all the
  other example scripts for the HOWTO.

30 files changed:
doc/gpgme-python-howto.texi
lang/python/docs/gpgme-python-howto.org
lang/python/examples/howto/add-userid.py
lang/python/examples/howto/clear-sign-file.py
lang/python/examples/howto/create-key.py
lang/python/examples/howto/decrypt-file.py
lang/python/examples/howto/detach-sign-file.py
lang/python/examples/howto/encrypt-file.py
lang/python/examples/howto/encrypt-sign-file.py
lang/python/examples/howto/encrypt-to-group-gullible.py
lang/python/examples/howto/encrypt-to-group-trustno1.py
lang/python/examples/howto/encrypt-to-group.py
lang/python/examples/howto/export-key.py
lang/python/examples/howto/export-minimised-key.py
lang/python/examples/howto/export-secret-key.py
lang/python/examples/howto/export-secret-keys.py
lang/python/examples/howto/groups.py
lang/python/examples/howto/import-key.py
lang/python/examples/howto/import-keys.py
lang/python/examples/howto/keycount.py
lang/python/examples/howto/mutt-groups.py
lang/python/examples/howto/pmkey-import-alt.py
lang/python/examples/howto/pmkey-import.py
lang/python/examples/howto/revoke-userid.py
lang/python/examples/howto/sign-file.py
lang/python/examples/howto/sign-key.py
lang/python/examples/howto/symcrypt-file.py
lang/python/examples/howto/temp-homedir-config.py
lang/python/examples/howto/verify-signatures.py
lang/python/examples/howto/verify-signed-file.py

index 2863d57..7b8b79d 100644 (file)
@@ -843,12 +843,19 @@ importing of the keys found.
 @example
 import gpg
 import hkp4py
+import sys
 
 c = gpg.Context()
-server = hkp4py.KeyServer("https://hkps.pool.sks-keyservers.net")
-pattern = input("Enter the pattern to search for keys or user IDs: ")
+server = hkp4py.KeyServer("hkps://hkps.pool.sks-keyservers.net")
 results = []
 
+if len(sys.argv) > 2:
+    pattern = " ".join(sys.argv[1:])
+elif len(sys.argv) == 2:
+    pattern = sys.argv[1]
+else:
+    pattern = input("Enter the pattern to search for keys or user IDs: ")
+
 try:
     keys = server.search(pattern)
     print("Found @{0@} key(s).".format(len(keys)))
@@ -2377,6 +2384,11 @@ Without that recent addition it would have been necessary to encode
 the contents of each @samp{hkp4py.KeyServer().search()[i].key} in
 @samp{hkp4py.KeyServer().search()} before trying to import it.
 
+An example of this is included in the @ref{Importing keys, , Importing Keys} section of this
+HOWTO and the corresponding executable version of that example is
+available in the @samp{lang/python/examples/howto} directory as normal; the
+executable version is the @samp{import-keys-hkp.py} file.
+
 @node Copyright and Licensing
 @chapter Copyright and Licensing
 
index 58964f3..b5b9ed4 100644 (file)
@@ -2288,6 +2288,10 @@ Without that recent addition it would have been necessary to encode
 the contents of each =hkp4py.KeyServer().search()[i].key= in
 =hkp4py.KeyServer().search()= before trying to import it.
 
+An example of this is included in the [[#howto-import-key][Importing Keys]] section of this
+HOWTO and the corresponding executable version of that example is
+available in the =lang/python/examples/howto= directory as normal; the
+executable version is the =import-keys-hkp.py= file.
 
 
 * Copyright and Licensing
index b868979..0c7bb89 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 597bbc5..9d350e2 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 429ab1f..02d1cb3 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 2fe37f2..8eba1f2 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 99fbe65..a0c5a2a 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 7c84a6f..8951cb5 100755 (executable)
@@ -21,7 +21,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index a08176b..6610ee0 100755 (executable)
@@ -21,7 +21,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index c96e829..5ba82bc 100755 (executable)
@@ -22,7 +22,7 @@ from groups import group_lists
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index da0376b..680c9ea 100755 (executable)
@@ -22,7 +22,7 @@ from groups import group_lists
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index d4cb074..e4ef1b6 100755 (executable)
@@ -22,7 +22,7 @@ from groups import group_lists
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 913bfce..80768fe 100755 (executable)
@@ -22,7 +22,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 3889adc..9d5f848 100755 (executable)
@@ -22,7 +22,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index e9c53fe..ccc9f45 100755 (executable)
@@ -23,7 +23,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 0f4d8ee..f2f1ccd 100755 (executable)
@@ -24,7 +24,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 7213538..3d51b25 100644 (file)
@@ -17,7 +17,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 2591378..ab52ba2 100755 (executable)
@@ -24,7 +24,7 @@ del absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index bdc15a6..d1a268e 100755 (executable)
@@ -22,7 +22,7 @@ import requests
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 8e25454..af47272 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index c0b515a..6572a21 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 1b260e1..c7822f3 100755 (executable)
@@ -25,7 +25,7 @@ del absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 66ad8aa..58a01c8 100755 (executable)
@@ -24,7 +24,7 @@ del absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 7a3d190..be34748 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 01006df..f680965 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index b1afe13..6d32c57 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 785a4d0..bce9286 100755 (executable)
@@ -21,7 +21,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 1111fe2..98bde36 100755 (executable)
@@ -22,7 +22,7 @@ import sys
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 8aafc3b..aa4331c 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see
index 9f8702f..c561fe8 100755 (executable)
@@ -18,7 +18,7 @@ from __future__ import absolute_import, division, unicode_literals
 # This program is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
-# Lesser General Public Licensefor more details.
+# Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License and the GNU
 # Lesser General Public along with this program; if not, see