aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/doc/texinfo/gpgme-python-howto.texi (unfollow)
Commit message (Collapse)AuthorFilesLines
2019-07-12python: doc: Remove generated files, put rules in Makefile.NIIBE Yutaka1-3483/+0
* lang/python/doc/Makefile.am (EXTRA_DIST): Remove files not distributed like files under meta. * Add rules to generate .rst and .texi files. * lang/python/doc/rst: Remove .rst files to be generated. * lang/python/doc/texinfo: Remove .texi files to be generated. GnuPG-bug-id: 4275 Signed-off-by: NIIBE Yutaka <[email protected]>
2019-01-30python: docsBen McGinnes1-2/+2
* Version bump in preparation for whenever GPGME 1.13.0 happens. * Ran the post_installer.py for docs preparation again. Signed-off-by: Ben McGinnes <[email protected]>
2019-01-27python: post installer docs fix scriptBen McGinnes1-1/+16
* Moved post_installer.py into the examples/howto/ directory. * Added instructions for its use to the Python Bindings HOWTO. * Ran it as intended from the lang/python/ directory in order to both prove it works and quickly and easily get the updated howto replicated. Also to fix all those .texi files. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-12-21python: docsBen McGinnes1-21/+72
* Found a bug in org-mode's export to texinfo function which will require either manual modification of each file or a customs sed run over the generated files for all updates. * Manually updated the current files for now, but will need to add some post-install processing scripts for future use (I already have some of these for my specific setup, they just need to be made a little more generic and platform independent for here). Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-12-16python: howto and examplesBen McGinnes1-15/+17
* Tightening up both the documentation and some of the example code. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-12-10python: HKP search and import updatesBen McGinnes1-12/+55
* Tweaked the code again so that it can also handle the cases where someone has included a hexadecimal string in their user ID. * Updated the HOWTO to match. * Exported to .rst and .texi.
2018-12-10python: docs updatesBen McGinnes1-3/+13
* Multiple updates, expanding on the Windows installation issues. * Also adding to the new maintenance mode reference document. * Includes content relating to the resolution of T4271 and T4191. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-12-04python: windows c and cythonBen McGinnes1-0/+7
* added warning that he Windows C runtime issues will also affect use with Cython and that relying on binary installers would remove that possible use case.
2018-12-04python: docs updateBen McGinnes1-5/+97
* Expanded the section on issues with Windows installations, with greater detail of which versions of Visual Studio are needed depending on which version of CPython is to be used. * Included a recommendation which is a bit harsh without being totally prickish. * Updated all files to not link to author's key or related data in order to make them all consistent with the changes in commit 649b19688132dd315e361c0f5b63ba6d8f45996d. Signed-off-by: Ben McGinnes <[email protected]>
2018-11-30python: documentationBen McGinnes1-21/+25
* Added long description to setup.py.in. * Added maintenance mode details with clarification for what type of things would be a bug as far as MM is concerned and what wouldn't be. ** Includes a not too subtle hint directed towards the donations page. * Miscellaneous tightening of documentation. Signed-off-by: Ben McGinnes <[email protected]>
2018-11-26python docs: checking key signaturesBen McGinnes1-8/+90
* Added instructions for checking key certifications or key signatures (depending on preferred terminology). * Added pendulum module to recommended installations, but not to requirements. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-11-22python: docs updateBen McGinnes1-9/+94
* Added documentation for the new methods added to gpgme.version. * Removed the Flask based advanced use case from the what-is-new section as that type of code will not be added here.
2018-11-08spelling: fix misspellingsDaniel Kahn Gillmor1-4/+4
Signed-off-by: Daniel Kahn Gillmor <[email protected]>
2018-11-06docs: python bindingsBen McGinnes1-99/+36
* Continued restructuring as part of moving beyond mere;y the HOWTO file. * Generated the alternative source files for reST and Texinfo. * Fixed some errors and updated links after moving the what's new section to two new files (yes, two).
2018-10-18doc: convert more http:// links to https://Daniel Kahn Gillmor1-3/+3
-- Signed-off-by: Daniel Kahn Gillmor <[email protected]>
2018-10-04docs: pythonBen McGinnes1-2/+1
* Fixed an error in the new index page and then exported to the other two "source" formats.
2018-10-04python: makefilesBen McGinnes1-0/+0
* doc/Makefile.am: Removed a bit I forgot about. * Renamed lang/python/docs to lang/python/doc bvecause apparently automake cares about that too. * Decided to be extra explicit in the manifest because if I don't then all sorts of things get deleted ... like lang/python * Tested on an external linux system just in case my osx workstation introduces too much weirdness. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-10-03dpcs: python howtoBen McGinnes1-1000/+1128
* More updates to the docs themselves and the versions to be available with the next release. * .texi and .rst copies of the HOWTO and the short history of (this part) of the project.
2018-10-03docs: python bindingsBen McGinnes1-0/+0
* Restructured the docs directory to account for the GNU preferred source doc format (.texi) and the Python preferred source doc format (.rst) and the real source doc format (.org). * Both the perceived source formats will need to be generated from the .org files and included at this stage. Unfortunately there is not yet a native org-to-rst transformation method in the org-mode software in Emacs nor is there a a direct means of going from reST to Org-mode from Docutils. There's only third party packages like Pandoc and, while very good, there is no guarantee of consistency; so we can't entirely automate this bit (yet).
2018-10-02python bindings: CPython orderBen McGinnes1-8/+26
* Changed the order of python versions the configure/make process checks for, placing Python 3.7 ahead of 3.6. * Updated the HOWTO documentation to reflect this change. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-09-30docs: python bindingsBen McGinnes1-2/+27
* Tightened up the docs a little bit, updated the "what's new" section, dropped the "-draft" version in preparation for GPGME 1.12.0's release. * Exported another .texi version (and updated the draft copies to this commit (which ought to be 1.11.1-beta313). Signed-off-by: Ben McGinnes <[email protected]>
2018-09-27docs: python bindings installationBen McGinnes1-0/+67
* lang/python/docs/gpgme-python-howto.org: added a section on installing the bindings to a python virtualenv.
2018-09-25docs: a typographical two-stepBen McGinnes1-1/+1
* Sometimes you really do need or want punctuation in a heading, but ideally without something else generating whitespace and other annoyances to go with it. * Trying a real decimal point instead. Signed-off-by: Ben McGinnes <[email protected]>
2018-09-24docs and examples: python bindingsBen McGinnes1-10/+154
* Woumd up the "what's new" section. * Added an example for sending a key to the keyservers via hkp4py. * Updated the export key code to use a more complete check for the $GNUPGHOME location. * Expanded on the installation and reinstallation troubleshooting section. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-09-24docs: python bindings howtoBen McGinnes1-2/+70
* Added a What's New section to summarise changes since the last release. There have been quite a few and some attention does need to be drawn to some of them. * Confirming certain issues with some platform builds, especially BSD/OSX vs. Linux issues which will need to update the installation troubleshooting guides.
2018-09-23docs and examples: python bindings howtoBen McGinnes1-53/+374
* Added more comprehensive examples using hkp4py and added a couple more example scripts for protonmail. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-09-23examples: python bindings and hkp4py updatesBen McGinnes1-0/+4
* Mostly tightening up the details on the hkp4py example script. * Also fixed a typo in the LGPL boiler plate text included in all the other example scripts for the HOWTO.
2018-09-22python bindings: importing from keyservers with hkp4pyBen McGinnes1-3/+90
* added a new example script to search the keyservers and import the results, this time using Marcel Fest's hkp4py module. * Updated the key importing section to match this addition. * Tested with the current version of hkp4py from github. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-09-22docs: python bindings howtoBen McGinnes1-1/+19
* Confirmed that updates to the tests have significant'y improved that output. * Updated some of the additional notes for the section on hkp4py. ** This is in anticipation adding at least import examples using that module as well. It may also include adding examples of exporting a key and uploading it to the keyservers. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-09-20docs: python bindings and its special requestBen McGinnes1-3/+31
* Added some material on using the new-ish hkp4py module with GPGME. * Example code will be added later once a couple of little issues are addressed. Signed-off-by: Ben McGinnes <[email protected]>
2018-09-17docs: python bindingsBen McGinnes1-3/+7
* Updated the Cython example code slightly, along with the corresponding explanation.
2018-09-17docs: python bindings howtoBen McGinnes1-20/+11
* Tightened up the Cython demonstration.
2018-09-16docs: cython sanitizedBen McGinnes1-2/+5
* Sanitized the shell command examples of extraneous whitespace. * Removed keycount.c as sanitising it is pointless and it will be generated by Cython when the example is followed. * Regenerated the .texi version.
2018-09-16docs: python bindings howtoBen McGinnes1-0/+116
* Added new advanced section with an example of using the Python bindings with CPython code compiled back to C code using Cython. * Though it may seem a bit counter-intuitive to use the bindings just to go back to C via a different route, this is not actually stupid. * Added examples/howto/advanced/cython/ directory. * Added keycount.pyx, setup.py and the keycount.c file which the first two generated with Cython. Not including the .so and .o files from the build. * Exported the .texi version of the howto for the main docs.
2018-09-16docs: even more editsBen McGinnes1-1/+1
* doc/gpgme-python-howto.texi: hunting down and killing commas, Oxford or not it can't stay in a heading.
2018-09-16docs: more editsBen McGinnes1-1/+3
* lang/python/docs/gpgme-python-howto.org: more tweaks and edits, along with another build of output formats. * doc/gpgme-python-howto.texi: updated texinfo version for parent docs.
2018-09-15docs: whitespace culledBen McGinnes1-4/+16
* lang/python/docs/gpgme-python-howto.org: Identified and fixed the headings which kept generating lines with trailing whitespace when exporting to Texinfo format and adjusted them to prevent that.
2018-09-15docs: renaming and draftsBen McGinnes1-0/+34
* lang/python/docs/gpgme-python-howto.org: Renamed file to better fit the rest of the project's docs. * Added a section on the very unofficial drafts I periodically post links to since they're often the easiest way to get a web version in front of someone in a hurry.
2018-09-15docs: Python howto updateBen McGinnes1-1/+7
* lang/python/docs/GPGMEpythonHOWTOen.org: Added corresponding GPGME version number to table at the start and cut the shortcut from the groups.py example. * doc/gpgme-python-howto.texi: New export of Texinfo file for docs build.
2018-09-15Python bindings: docsBen McGinnes1-16/+38
* lang/python/docs/GPGMEpythonHOWTOen.org: Fixed a few errors in the newer sections. * Updated code in the examples using secret key exporting and group lines to reflect the Python 2.7 compatibility fixes added.
2018-08-31docs: python bindingsBen McGinnes1-2/+2
* minor typographic update. Signed-off-by: Ben McGinnes <[email protected]>
2018-08-29docs: python bindings - protonmail examplesBen McGinnes1-1/+13
* lang/python/docs/GPGMEpythonHOWTOen.org: Updated links to the ProtonMail keyserver import scripts and added a warning regarding being unable to update third party keys. * lang/python/examples/howto/pmkey-import-alt.py: added usage. * lang/python/examples/howto/pmkey-import.py: added usage.
2018-08-28docs: python bindings HOWTOBen McGinnes1-13/+24
* Finished CFFI vs SWIG bit in known issues. * tidied up some of the structure. * Fixed some minor errors and links.
2018-08-28docs: python bindingsBen McGinnes1-3/+22
* Added section on why no CFFI.
2018-08-28docs: python howtoBen McGinnes1-0/+94
* Added another key import example using ProtonMail's new keyserver.
2018-08-27docs: python bindingsBen McGinnes1-1/+157
* Added details on installation troubleshooting.
2018-07-22docs: python bindings howtoBen McGinnes1-170/+169
* Fixed and tested the changes necessary for org-mode to correctly parse pythonic (Python 3) indentation. * Updated the source blocks to recommended upper case for BEGIN_SRC and END_SRC. * Tested and confirmed XHTML output matches correct examples. * Tested against pseudo-control output via exporting from org-mode to org-mode and then exporting that to XHTML. Remaining differences appear to be discarding the custom tags used to provide X[HT]ML id elements to each section which does not appear to offer any benefit. * Exporting directly to XHTML or other HTML output should no longer cause problems, but if there are any then the first step should be exporting from org-to-org and then exporting that to XHTML. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
2018-07-22doc: python bindings howtoBen McGinnes1-624/+623
* Another retrofitting of the HOWTO Python example code, this time following adjustments to python-mode configuration and having trawled through the org-mode mailing lists for clues.
2018-07-22doc: python bindings howtoBen McGinnes1-0/+1
* Added org-mode byline.
2018-07-09docs: python bindings howtoBen McGinnes1-1251/+1235
* Complete typographic overhaul. * Removed all section level indentation since it does not affect output formatting, but might affect source code examples. * In text-mode stripped out all tabs which had crept in and replaced them with four spaces. * Updated all code examples (again) to conform with Python-mode. * Bumped version number in preparation for next release of GPG 2.2.9 and corresponding GPGME release.