Compare commits

...

4 Commits

Author SHA1 Message Date
Ben McGinnes
14402ece2f Merge branch 'master' into ben-minor-fixes 2016-08-17 13:14:44 +10:00
Ben McGinnes
71d8536f62 TODO stuff
* Expanded the documentation section to reflect the quandary with
  quality documentation.
2016-08-17 02:16:41 +10:00
Ben McGinnes
5c44454d00 Historical Record
* Minor grammatical fixes.
* Added paragraph on Justus' updates.
* Rewrote PyPI section as it is now available there (as pyme3).
2016-08-17 02:11:12 +10:00
Ben McGinnes
5eb79cce0c Spelling fix
* Changed binginds to bindings.  :)
2016-08-17 01:27:07 +10:00
3 changed files with 35 additions and 7 deletions

View File

@ -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

View File

@ -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.

View File

@ -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).