diff options
Diffstat (limited to 'lang/python/doc/texinfo/gpgme-python-howto.texi')
| -rw-r--r-- | lang/python/doc/texinfo/gpgme-python-howto.texi | 135 |
1 files changed, 36 insertions, 99 deletions
diff --git a/lang/python/doc/texinfo/gpgme-python-howto.texi b/lang/python/doc/texinfo/gpgme-python-howto.texi index 695ed15a..d776f58d 100644 --- a/lang/python/doc/texinfo/gpgme-python-howto.texi +++ b/lang/python/doc/texinfo/gpgme-python-howto.texi @@ -43,6 +43,7 @@ Introduction What's New +* New in GPGME 1·13·0:: * New in GPGME 1·12·0:: GPGME Concepts @@ -138,7 +139,7 @@ Creating keys and subkeys User IDs * Adding User IDs:: -* Revokinging User IDs:: +* Revoking User IDs:: Advanced or Experimental Use Cases @@ -230,98 +231,24 @@ major releases. @node What's New @section What's New -The most obviously new point for those reading this guide is this -section on other new things, but that's hardly important. Not given -all the other things which spurred the need for adding this section -and its subsections. +Full details of what is new are now available in the @uref{what-is-new.org, What's New} file +and archives of the preceding @emph{What's New} sections are available in +the @uref{what-was-new, What Was New} file. @menu +* New in GPGME 1·13·0:: * New in GPGME 1·12·0:: @end menu -@node New in GPGME 1·12·0 -@subsection New in GPGME 1·12·0 +@node New in GPGME 1·13·0 +@subsection New in GPGME 1·13·0 -There have been quite a number of additions to GPGME and the Python -bindings to it since the last release of GPGME with versions 1.11.0 -and 1.11.1 in April, 2018. +See the @uref{what-is-new#new-stuff-1-13-0, What's New} document for what is new in version 1.13.0. -The bullet points of new additiions are: +@node New in GPGME 1·12·0 +@subsection New in GPGME 1·12·0 -@itemize -@item -an expanded section on @ref{Installation, , installing} and @ref{Known Issues, , troubleshooting} the Python -bindings. -@item -The release of Python 3.7.0; which appears to be working just fine -with our bindings, in spite of intermittent reports of problems for -many other Python projects with that new release. -@item -Python 3.7 has been moved to the head of the specified python -versions list in the build process. -@item -In order to fix some other issues, there are certain underlying -functions which are more exposed through the @ref{Context, , gpg.Context()}, but -ongoing documentation ought to clarify that or otherwise provide the -best means of using the bindings. Some additions to @samp{gpg.core} and -the @samp{Context()}, however, were intended (see below). -@item -Continuing work in identifying and confirming the cause of -oft-reported @ref{Won't Work With Windows, , problems installing the Python bindings on Windows}. -@item -GSOC: Google's Surreptitiously Ordered Conscription @dots{} erm @dots{} oh, -right; Google's Summer of Code. Though there were two hopeful -candidates this year; only one ended up involved with the GnuPG -Project directly, the other concentrated on an unrelated third party -project with closer ties to one of the GNU/Linux distributions than -to the GnuPG Project. Thus the Python bindings benefited from GSOC -participant Jacob Adams, who added the key@math{_import} function; building -on prior work by Tobias Mueller. -@item -Several new methods functions were added to the gpg.Context(), -including: @ref{Importing keys, , key@math{_import}}, @ref{Exporting keys, , key@math{_export}}, @ref{Exporting public keys, , key@math{_export}@math{_minimal}} and -@ref{Exporting secret keys, , key@math{_export}@math{_secret}}. -@item -Importing and exporting examples include versions integrated with -Marcel Fest's recently released @uref{https://github.com/Selfnet/hkp4py, HKP for Python} module. Some -@ref{Keyserver access for Python, , additional notes on this module} are included at the end of the HOWTO. -@item -Instructions for dealing with semi-walled garden implementations -like ProtonMail are also included. This is intended to make things -a little easier when communicating with users of ProtonMail's -services and should not be construed as an endorsement of said -service. The GnuPG Project neither favours, nor disfavours -ProtonMail and the majority of this deals with interacting with the -ProtonMail keyserver. -@item -Semi-formalised the location where @ref{Draft Editions of this HOWTO, , draft versions} of this HOWTO may -periodically be accessible. This is both for the reference of -others and testing the publishing of the document itself. Renamed -this file at around the same time. -@item -The Texinfo documentation build configuration has been replicated -from the parent project in order to make to maintain consistency -with that project (and actually ship with each release). -@item -a reStructuredText (@samp{.rst}) version is also generated for Python -developers more used to and comfortable with that format as it is -the standard Python documentation format and Python developers may -wish to use it with Sphinx. Please note that there has been no -testing of the reStructuredText version with Sphinx at all. The -reST file was generated by the simple expedient of using @uref{https://pandoc.org/, Pandoc}. -@item -Added a new section for @ref{Advanced or Experimental Use Cases, , advanced or experimental use}. -@item -Began the advanced use cases with @ref{C plus Python plus SWIG plus Cython, , a section} on using the module with -@uref{https://cython.org/, Cython}. -@item -Added a number of new scripts to the @samp{example/howto/} directory; -some of which may be in advance of their planned sections of the -HOWTO (and some are just there because it seemed like a good idea at -the time). -@item -Cleaned up a lot of things under the hood. -@end itemize +See the @uref{what-was-new#new-stuff-1-12-0, What Was New} document for what was new in version 1.12.0. @node GPGME Concepts @chapter GPGME Concepts @@ -418,7 +345,7 @@ version 3.0 (or any later version). This package is the origin of these bindings, though they are somewhat different now. For details of when and how the PyME package was -folded back into GPGME itself see the @uref{short-history.org, Short History} document.@footnote{@samp{short-history.org} and/or @samp{short-history.html}.} +folded back into GPGME itself see the @uref{short-history.org, Short History} document.@footnote{@samp{short-history} and/or @samp{short-history.html}.} The PyME package was first released in 2002 and was also the first attempt to implement a low level binding to GPGME. In doing so it @@ -670,7 +597,7 @@ place. @node Multiple installations @subsection Multiple installations -For a veriety of reasons it may be either necessary or just preferable +For a variety of reasons it may be either necessary or just preferable to install the bindings to alternative installed Python versions which meet the requirements of these bindings. @@ -687,6 +614,15 @@ by major version numbers and probably minor numbers too). On most POSIX systems, including OS X, this will very likely be the case in most, if not all, cases. +Note that from GPGME @uref{https://dev.gnupg.org/rMff6ff616aea6f59b7f2ce1176492850ecdf3851e, 1.12.1} the default installation installs to each +version of Python it can find first. That is that it will currently +install for the first copies of Python versions 2.7, 3.4, 3.5, 3.6, +3.7 and 3.8 (dev branch) that it finds. Usually this will be in the +same prefix as GPGME itself, but is dictated by the @samp{$PATH} when the +installation is performed. The above instructions can still be +performed on other python installations which the installer does not +find, including alternative prefixes. + @node Won't Work With Windows @subsection Won't Work With Windows @@ -800,10 +736,10 @@ to or which are found by GPGME's configuration stage immediately prior to running the make commands. Which is exactly what the compiling and installing process of GPGME does by default. -Once that is done, however, it appears that a copy the compiled module -may be installed into a virtualenv of the same major and minor version -matching the build. Alternatively it is possible to utilise a -@samp{sites.pth} file in the @samp{site-packages/} directory of a viertualenv +Once that is done, however, it appears that a copy of the compiled +module may be installed into a virtualenv of the same major and minor +version matching the build. Alternatively it is possible to utilise a +@samp{sites.pth} file in the @samp{site-packages/} directory of a virtualenv installation, which links back to the system installations corresponding directory in order to import anything installed system wide. This may or may not be appropriate on a case by case basis. @@ -2724,7 +2660,7 @@ bash-4.4$ @menu * Adding User IDs:: -* Revokinging User IDs:: +* Revoking User IDs:: @end menu @node Adding User IDs @@ -2763,8 +2699,8 @@ ssb rsa3072 2018-03-15 [E] [expires: 2018-09-13] bash-4.4$ @end example -@node Revokinging User IDs -@subsection Revokinging User IDs +@node Revoking User IDs +@subsection Revoking User IDs Revoking a user ID is a fairly similar process, except that it uses the @samp{key_revoke_uid} method. @@ -3009,7 +2945,7 @@ is the key IDs of the group as a string. The @samp{group_lists} result is very similar in that it is a list of lists. The first part, @samp{group_lists[i][0]} matches @samp{group_lines[i][0]} as the name of the group, but @samp{group_lists[i][1]} -is the key IDs of the group as a string. +is the key IDs of the group as a list. A demonstration of using the @samp{groups.py} module is also available in the form of the executable @samp{mutt-groups.py} script. This second @@ -3116,15 +3052,16 @@ from the author at any of the following URLs: All of these draft versions except for one have been generated from this document via Emacs @uref{https://orgmode.org/, Org mode} and @uref{https://www.gnu.org/software/texinfo/, GNU Texinfo}. Though it is likely -that the specific @uref{https://files.au.adversary.org/crypto/gpgme-python-howto.org, file} @uref{http://files.au.adversary.org/crypto/gpgme-python-howto.org, version} used will be on the same server with +that the specific @uref{https://files.au.adversary.org/crypto/gpgme-python-howto, file} @uref{http://files.au.adversary.org/crypto/gpgme-python-howto.org, version} 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 -the following command: +either of the following two commands: @example -pandoc -f org -t rst+smart -o gpgme-python-howto.rst gpgme-python-howto.org +pandoc -f org -t rst -o gpgme-python-howto.rst gpgme-python-howto.org +pandoc -f org -t rst -o gpgme-python-howto.rst gpgme-python-howto @end example In addition to these there is a significantly less frequently updated @@ -3152,4 +3089,4 @@ WITHOUT ANY WARRANTY, to the extent permitted by law; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -@bye +@bye
\ No newline at end of file |