History
[gpgme.git] / lang / python / docs / Short_History.org
1 #+TITLE: A Short History of the GPGME bindings for Python
2
3 * Overview
4   :PROPERTIES:
5   :CUSTOM_ID: overview
6   :END:
7
8 The GPGME Python bindings passed through many hands and numerous
9 phases before, after a fifteen year journey, coming full circle to
10 return to the source.  This is a short explanation of that journey.
11
12 ** In the beginning
13    :PROPERTIES:
14    :CUSTOM_ID: in-the-begining
15    :END:
16
17    In 2002 John Goerzen released PyME; Python bindings for the GPGME
18    module which utilised the current release of Python of the time
19    (Python 2.2 or 2.3) and SWIG.  Shortly after creating it and
20    ensuring it worked he stopped supporting it, though he left his
21    work available on his Gopher site.
22
23    A couple of years later the project was picked up by Igor Belyi and
24    actively developed and maintained by him from 2004 to 2008.  Igor's
25    whereabouts at the time of this document's creation are unknown,
26    but the current authors do hope he is well.  We're assuming (or
27    hoping) that life did what life does and made continuing untenable.
28
29    In 2014 Martin Albrecht wanted to patch a bug in the PyME code and
30    discovered the absence of Igor.  Following a discussion on the PyME
31    mailing list he became the new maintainer for PyME, releasing
32    version 0.9.0 in May of that year.  He remains the maintainer of
33    the original PyME release in Python 2.6 and 2.7 (available via
34    PyPI).
35
36    In 2015 Ben McGinnes approached Martin about a Python 3 version,
37    while investigating how complex a task this would be the task ended
38    up being completed.  A subsequent discussion with Werner Koch led to
39    the decision to fold the Python 3 port back into the original GPGME
40    release in the languages subdirectory for non-C bindings.  Ben is
41    the maintainer of the Python 3 port within GPGME.
42
43    In 2016 PyME was renamed to "gpg" and adopted by the upstream GnuPG
44    team.
45
46 ** The Annoyances of Git
47    :PROPERTIES:
48    :CUSTOM_ID: the-annoyances-of-git
49    :END:
50
51    As anyone who has ever worked with git knows, submodules are
52    horrible way to deal with pretty much anything.  In the interests
53    of avoiding migraines, that is being skipped with addition of PyME
54    to GPGME.  Instead the files will be added to the subdirectory,
55    along with a copy of the entire git log up to that point as a
56    separate file within the docs directory (old-commits.log).  As the
57    log for PyME is nearly 100KB and the log for GPGME is approximately
58    1MB, this would cause considerable bloat, as well as some
59    confusion, should the two be merged.  Hence the unfortunate, but
60    necessary, step to simply move the files.  A regular repository
61    version will be maintained should it be possible to implement this
62    better in the future.
63
64 ** The Perils of PyPI
65    :PROPERTIES:
66    :CUSTOM_ID: the-perils-of-pypi
67    :END:
68
69    At the current time the Python 3 fork is not available via PyPI and
70    the pip installer.  The recommended installation method is to follow
71    the instructions in lang/py3-pyme/INSTALL.  This will build the
72    necessary SWIG portions against the installed version of GPGME.