[git] GPGME - branch, ben/minor-docs-fixes, created. gpgme-1.6.0-289-g71d8536

[by Ben McGinnes]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GnuPG Made Easy".

The branch, ben/minor-docs-fixes has been created
        at  71d8536f624948a48f9fdda1384363a41a470b69 (commit)

- Log -----------------------------------------------------------------
commit 71d8536f624948a48f9fdda1384363a41a470b69
Author: Ben McGinnes <ben at adversary.org>
Date:   Wed Aug 17 02:16:41 2016 +1000

    TODO stuff
    
    * Expanded the documentation section to reflect the quandary with
      quality documentation.

diff --git a/lang/python/docs/TODO.rst b/lang/python/docs/TODO.rst
index a398ccd..d3e0719 100644
--- a/lang/python/docs/TODO.rst
+++ b/lang/python/docs/TODO.rst
@@ -21,3 +21,11 @@ Documentation is to be moved to a more appropriate docs/ directory and
 produced using reST in preparation for inevitable publication by way
 of Sphinx and the existing infrastructure at readthedocs.org or the
 projects new home at gnupg.org.
+
+Alternatively Org-Mode might be used, as with the rest of the GNU
+Privacy Guard projects.
+
+The third option is to use an XML based build process with greater
+support for multilingual publications such as those provided by ruby
+domains (that's the XML ruby, not the programming language ruby;
+they're totally different things).

commit 5c44454d0047364605b3b7a7549d2593f2cb0492
Author: Ben McGinnes <ben at adversary.org>
Date:   Wed Aug 17 02:11:12 2016 +1000

    Historical Record
    
    * Minor grammatical fixes.
    * Added paragraph on Justus' updates.
    * Rewrote PyPI section as it is now available there (as pyme3).

diff --git a/lang/python/docs/Short_History.rst b/lang/python/docs/Short_History.rst
index 126c121..2fa03c9 100644
--- a/lang/python/docs/Short_History.rst
+++ b/lang/python/docs/Short_History.rst
@@ -27,14 +27,20 @@ decision to fold the Python 3 port back into the original GPGME
 release in the languages subdirectory for non-C bindings.  Ben is the
 maintainer of the Python 3 port within GPGME.
 
+In 2016 Justus Winter updated a number of the Python 3 PyME SWIG
+bindings during the course of GnuPG 2.1 development.  During the
+course of this process the port was added to PyPI under the
+alternative name of pyme3 (so as not to clash with the original
+package for Python 2.6 and 2.7).
+
 
 ---------------------
 The Annoyances of Git
 ---------------------
 
-As anyone who has ever worked with git knows, submodules are horrible
+As anyone who has ever worked with git knows, submodules are a horrible
 way to deal with pretty much anything.  In the interests of avoiding
-migraines, that is being skipped with addition of PyME to GPGME.
+migraines, that is being skipped with the addition of PyME to GPGME.
 Instead the files will be added to the subdirectory, along with a copy
 of the entire git log up to that point as a separate file within the
 docs directory (old-commits.log).  As the log for PyME is nearly 100KB
@@ -49,7 +55,21 @@ possible to implement this better in the future.
 The Perils of PyPI
 ------------------
 
-At the current time the Python 3 fork is not available via PyPI and
-the pip installer.  The recommended installation method is to follow
-the instructions in lang/py3-pyme/INSTALL.  This will build the
-necessary SWIG portions against the installed version of GPGME.
+This port is currently available in PyPI as pyme3 and uses the GPGME
+version number from build time.  
+
+Alternatively compiling GPGME and installing it from source will also
+install the current version of PyME if Python 3 is detected.  If
+multiple versions of Python 3 are installed then it will install in
+the site-packages directory of the first installation located.
+
+The version installed through either method can be checked like this:
+
+::
+   >>> from pyme import core
+   >>> print(core.check_version())
+   1.7.0-beta257
+   >>>
+
+Installing from PyPI should still result in the module being named
+pyme when importing.

commit 5eb79cce0c05c28bde228f4b5b5a72506bcc32c5
Author: Ben McGinnes <ben at adversary.org>
Date:   Wed Aug 17 01:27:07 2016 +1000

    Spelling fix
    
    * Changed binginds to bindings.  :)

diff --git a/lang/python/README b/lang/python/README
index 7ce8894..8b8fc73 100644
--- a/lang/python/README
+++ b/lang/python/README
@@ -7,7 +7,7 @@ https://www.gnupg.org/related_software/gpgme/
 PyMe uses SWIG to create wrapper functions with automatic type
 conversions.  This way most of the functions and types are converted
 from C into Python 3 automatically by SWIG, reducing the maintenance
-cost of the binginds.
+cost of the bindings.
 
 * Authors
 

-----------------------------------------------------------------------


hooks/post-receive
-- 
GnuPG Made Easy
http://git.gnupg.org