Explaining why not all scripts work
authorBen McGinnes <ben@adversary.org>
Sat, 16 May 2015 19:14:47 +0000 (05:14 +1000)
committerBen McGinnes <ben@adversary.org>
Sat, 16 May 2015 19:14:47 +0000 (05:14 +1000)
* Some of them cannot be properly tested on OS X, especially with GTK in
  the mix (it works on OS X, but is unlikely to be as easily accessible
  as Cocoa or Qt).
* Most major functions are showcased and do work, albeit sometimes with
  false positives of error messages, at least on OS X.

lang/py3-pyme/examples/Examples.rst [new file with mode: 0644]

diff --git a/lang/py3-pyme/examples/Examples.rst b/lang/py3-pyme/examples/Examples.rst
new file mode 100644 (file)
index 0000000..18b03b2
--- /dev/null
@@ -0,0 +1,7 @@
+===============
+Example Scripts
+===============
+
+Most of the examples have been converted to work with Python 3, just as the original versions worked with Python 2.  A small number produce errors on OS X, but may behave differently on other POSIX systems.  The GTK based scripts (PyGtkGpgKeys.py and pygpa.py) have not been modified at all.
+
+When using or referring to the example scripts here, the most common change has been the byte encoded strings, so if something does not work then chances are that it will be related to the encoding or decoding of UTF-8.