aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/doc/rst
diff options
context:
space:
mode:
Diffstat (limited to 'lang/python/doc/rst')
-rw-r--r--lang/python/doc/rst/gpgme-python-howto.rst48
-rw-r--r--lang/python/doc/rst/index.rst3
-rw-r--r--lang/python/doc/rst/maintenance-mode.rst95
-rw-r--r--lang/python/doc/rst/short-history.rst22
-rw-r--r--lang/python/doc/rst/what-is-new.rst12
-rw-r--r--lang/python/doc/rst/what-was-new.rst7
6 files changed, 160 insertions, 27 deletions
diff --git a/lang/python/doc/rst/gpgme-python-howto.rst b/lang/python/doc/rst/gpgme-python-howto.rst
index dae4c646..d1cb3fd3 100644
--- a/lang/python/doc/rst/gpgme-python-howto.rst
+++ b/lang/python/doc/rst/gpgme-python-howto.rst
@@ -13,8 +13,11 @@ Introduction
| | e/index.html#sec-1-5>`__ |
| | <[email protected]> |
+-----------------------------------+-----------------------------------+
-| Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E237 |
-| | 3590E5D |
+| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D <https://hkps.pool.sks-k |
+| | eyservers.net/pks/lookup?search=0 |
+| | xDB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D&exact=on&op=get>`__ |
+-----------------------------------+-----------------------------------+
| Language: | Australian English, British |
| | English |
@@ -3009,34 +3012,37 @@ Draft Editions of this HOWTO
Draft editions of this HOWTO may be periodically available directly from
the author at any of the following URLs:
-- `GPGME Python Bindings HOWTO draft (XHTML AWS S3
+- `GPGME Python Bindings HOWTO draft (XHTML single file, AWS S3
SSL) <https://files.au.adversary.org/crypto/gpgme-python-howto.html>`__
-- `GPGME Python Bindings HOWTO draft (XHTML AWS S3 no
- SSL) <http://files.au.adversary.org/crypto/gpgme-python-howto.html>`__
-- `GPGME Python Bindings HOWTO draft (Texinfo file AWS S3
- SSL) <https://files.au.adversary.org/crypto/gpgme-python-howto.texi>`__
-- `GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 no
- SSL) <http://files.au.adversary.org/crypto/gpgme-python-howto.texi>`__
-- `GPGME Python Bindings HOWTO draft (Info file AWS S3
- SSL) <https://files.au.adversary.org/crypto/gpgme-python-howto.info>`__
-- `GPGME Python Bindings HOWTO draft (Info file AWS S3 no
- SSL) <http://files.au.adversary.org/crypto/gpgme-python-howto.info>`__
-- `GPGME Python Bindings HOWTO draft (reST file AWS S3
- SSL) <https://files.au.adversary.org/crypto/gpgme-python-howto.rst>`__
-- `GPGME Python Bindings HOWTO draft (reST file AWS S3 no
- SSL) <http://files.au.adversary.org/crypto/gpgme-python-howto.rst>`__
+- `GPGME Python Bindings HOWTO draft (XHTML single file, AWS S3 no
+ SS) <http://files.au.adversary.org/crypto/gpgme-python-howto.html>`__
+- `GPGME Python Bindings HOWTO draft (XHTML multiple files, AWS S3
+ SSL) <https://files.au.adversary.org/crypto/gpgme-python-howto-split/index.html>`__
+- `GPGME Python Bindings HOWTO draft (XHTML multiple files, AWS S3 no
+ SSL) <http://files.au.adversary.org/crypto/gpgme-python-howto-split/index.html>`__
All of these draft versions except for one have been generated from this
-document via Emacs `Org mode <https://orgmode.org/>`__ and `GNU
+document via GNU Emacs `Org mode <https://orgmode.org/>`__ and `GNU
Texinfo <https://www.gnu.org/software/texinfo/>`__. Though it is likely
that the specific
`file <https://files.au.adversary.org/crypto/gpgme-python-howto>`__
`version <http://files.au.adversary.org/crypto/gpgme-python-howto.org>`__
used will be on the same server with the generated output formats.
-The one exception is the reStructuredText version, which was converted
-using the latest version of Pandoc from the Org mode source file using
-either of the following two commands:
+The GNU Texinfo and reStructured Text versions ship with the software,
+while the GNU Emacs Info verseion is generated from the Texinfo version
+using GNU Texinfo or GNU Makeinfo. The Texinfo format is generated from
+the original Org mode source file in Org mode itself either within GNU
+Emacs or via the command line by invoking Emacs in batch mode:
+
+.. code:: shell
+
+ emacs gpgme-python-howto.org --batch -f org-texinfo-export-to-texinfo --kill
+ emacs gpgme-python-howto --batch -f org-texinfo-export-to-texinfo --kill
+
+The reStructuredText format is also generated from the Org-mode source
+file, except it is generated using `Pandoc <https://pandoc.org>`__ with
+either of the following commands:
.. code:: shell
diff --git a/lang/python/doc/rst/index.rst b/lang/python/doc/rst/index.rst
index 5f736c7e..746391c3 100644
--- a/lang/python/doc/rst/index.rst
+++ b/lang/python/doc/rst/index.rst
@@ -8,5 +8,8 @@ Contents
- `A short history of the project <short-history>`__
- `What\'s New <what-is-new>`__
+
+ - `Maintenance Mode <maintenance-mode>`__ (from January, 2019)
+
- `What Was New <what-was-new>`__
- `GPGME Python Bindings HOWTO <gpgme-python-howto>`__
diff --git a/lang/python/doc/rst/maintenance-mode.rst b/lang/python/doc/rst/maintenance-mode.rst
new file mode 100644
index 00000000..75cd947a
--- /dev/null
+++ b/lang/python/doc/rst/maintenance-mode.rst
@@ -0,0 +1,95 @@
+.. _maintenance-mode:
+
+Maintenance Mode from 2019
+==========================
+
++-----------------------------------+-----------------------------------+
+| Version: | 0.0.1-draft |
++-----------------------------------+-----------------------------------+
+| GPGME Version: | 1.13.0 |
++-----------------------------------+-----------------------------------+
+| Author: | `Ben |
+| | McGinnes <https://gnupg.org/peopl |
+| | e/index.html#sec-1-5>`__ |
+| | <[email protected]> |
++-----------------------------------+-----------------------------------+
+| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D <https://hkps.pool.sks-k |
+| | eyservers.net/pks/lookup?search=0 |
+| | xDB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D&exact=on&op=get>`__ |
++-----------------------------------+-----------------------------------+
+| Language: | Australian English, British |
+| | English |
++-----------------------------------+-----------------------------------+
+| xml:lang: | en-AU, en-GB, en |
++-----------------------------------+-----------------------------------+
+
+From the beginning of 2019 the Python bindings to GPGME will enter
+maintenance mode, meaning that new features will not be added and only
+bug fixes and security fixes will be made. This also means that
+documentation beyond that existing at the end of 2018 will not be
+developed further except to correct errors.
+
+Though use of these bindings appears to have been quite well received,
+there has been no indication of what demand there is, if any for either
+financial backing of the current Python bindings development or support
+contracts with g10code GmbH citing the necessity of including the
+bindings.
+
+.. _maintenance-mode-bm:
+
+Maintainer from 2019 onward
+---------------------------
+
+How does this affect the position of GnuPG Python Bindings Maintainer?
+
+Well, I will remain as maintainer of the bindings; but without funding
+for that position, the amount of time I will be able to dedicate solely
+to this task will be limited and reduced to volunteered time. As with
+all volunteered time and effort in free software projects, this will be
+subject to numerous external imperatives.
+
+.. _maintenance-mode-blade-runner:
+
+Using the Python Bindings from 2019 and beyond
+----------------------------------------------
+
+For most, if not all, Python developers using these bindings; they will
+continue to "just work" the same as they always have. Expansions of
+GPGME itself are usually handled by SWIG with the existing code and thus
+bindings are generated properly when the bindings are installed
+alongside GPGME and when the latter is built from source.
+
+In the rare circumstances where that is not enough to address some new
+addition to GPGME, then that is a bug and thus subject to the
+maintenance mode provisions (i.e. it will be fixed following a bug
+report being raised and your humble author will need to remember where
+the timesheet template was filed, depending on how many years off such
+an event is).
+
+All the GPGME functionality will continue to be accessible via the lower
+level, dynamically generated methods which match the GPGME C
+documentation. While the more intuitively Pythonic higher level layer
+already covers the vast majority of functionality people require with
+key generation, signatures, certifications (key signing), encryption,
+decryption, verification, validation, trust levels and so on.
+
+Any wanted features lacking in the Python bindings are usually lacking
+because they are missing from GPGME itself (e.g. revoking keys via the
+API) and in such cases they are usually deliberately excluded. More
+
+Any features existing in the dynamically generated layer for which
+people want a specific, higher level function included to make it more
+Pythonic (e.g. to avoid needing to learn or memorise cryptographic mode
+values or GnuPG status code numbers), would be a feature request and
+*not* a bug.
+
+It is still worthwhile requesting it, but the addition of such a feature
+would not be guaranteed and provided on a purely volunteer basis.
+Expediting such a request would require funding that request.
+
+Those with a commercial interest in expediting such a feature request
+already know how to `expedite
+it <https://gnupg.org/cgi-bin/procdonate.cgi?mode=preset>`__ (use the
+message field to state what feature is being requested).
diff --git a/lang/python/doc/rst/short-history.rst b/lang/python/doc/rst/short-history.rst
index d6f0a5d5..70f9b25e 100644
--- a/lang/python/doc/rst/short-history.rst
+++ b/lang/python/doc/rst/short-history.rst
@@ -1,6 +1,28 @@
Overview
========
++-----------------------------------+-----------------------------------+
+| Version: | 0.0.1-draft |
++-----------------------------------+-----------------------------------+
+| GPGME Version: | 1.13.0 |
++-----------------------------------+-----------------------------------+
+| Author: | `Ben |
+| | McGinnes <https://gnupg.org/peopl |
+| | e/index.html#sec-1-5>`__ |
+| | <[email protected]> |
++-----------------------------------+-----------------------------------+
+| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D <https://hkps.pool.sks-k |
+| | eyservers.net/pks/lookup?search=0 |
+| | xDB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D&exact=on&op=get>`__ |
++-----------------------------------+-----------------------------------+
+| Language: | Australian English, British |
+| | English |
++-----------------------------------+-----------------------------------+
+| xml:lang: | en-AU, en-GB, en |
++-----------------------------------+-----------------------------------+
+
The GPGME Python bindings passed through many hands and numerous phases
before, after a fifteen year journey, coming full circle to return to
the source. This is a short explanation of that journey.
diff --git a/lang/python/doc/rst/what-is-new.rst b/lang/python/doc/rst/what-is-new.rst
index 0fca98f2..b3ec06a7 100644
--- a/lang/python/doc/rst/what-is-new.rst
+++ b/lang/python/doc/rst/what-is-new.rst
@@ -13,8 +13,11 @@ What\'s New
| | e/index.html#sec-1-5>`__ |
| | <[email protected]> |
+-----------------------------------+-----------------------------------+
-| Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E237 |
-| | 3590E5D |
+| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D <https://hkps.pool.sks-k |
+| | eyservers.net/pks/lookup?search=0 |
+| | xDB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D&exact=on&op=get>`__ |
+-----------------------------------+-----------------------------------+
| Language: | Australian English, British |
| | English |
@@ -23,8 +26,7 @@ What\'s New
+-----------------------------------+-----------------------------------+
Last time the most obviously new thing was adding the *What\'s New*
-section to the HOWTO. Now it\'s moving it out of the HOWTO. Not to
-mention expanding on the documentation both generally and considerably.
+section to the HOWTO. Now it\'s moving it out of the HOWTO.
.. _new-stuff-1-13-0:
@@ -41,3 +43,5 @@ Additions since GPGME 1.12.0 include:
- Added ``gpg.version.versionintlist`` to make it easier for Python
developers to check for a specific version number, even with beta
versions (it will drop the \"-betaN\" part).
+- Bindings enter `maintenance mode <maintenance-mode>`__ from January,
+ 2019.
diff --git a/lang/python/doc/rst/what-was-new.rst b/lang/python/doc/rst/what-was-new.rst
index 23f30828..cc11bbfc 100644
--- a/lang/python/doc/rst/what-was-new.rst
+++ b/lang/python/doc/rst/what-was-new.rst
@@ -13,8 +13,11 @@ What Was New
| | e/index.html#sec-1-5>`__ |
| | <[email protected]> |
+-----------------------------------+-----------------------------------+
-| Author GPG Key: | DB4724E6FA4286C92B4E55C4321E4E237 |
-| | 3590E5D |
+| Author GPG Key: | `DB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D <https://hkps.pool.sks-k |
+| | eyservers.net/pks/lookup?search=0 |
+| | xDB4724E6FA4286C92B4E55C4321E4E23 |
+| | 73590E5D&exact=on&op=get>`__ |
+-----------------------------------+-----------------------------------+
| Language: | Australian English, British |
| | English |
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-17 14:14:00 +0000