aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* python: makefilesBen McGinnes2018-10-0410-21410/+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]>
* docs: more whitespace checksBen McGinnes2018-10-031-5/+5
| | | | * lang/python/docs/texinfo/short-history.texi:
* dpcs: python howtoBen McGinnes2018-10-035-8/+6545
| | | | | | | * 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.
* docs: pythonBen McGinnes2018-10-032-0/+9009
| | | | | * More restructuring. Also the painstaking task of deciphering some of the more eclectic aspects of Texinfo and make.
* docs: python bindingsBen McGinnes2018-10-034-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).
* docs: pre-python preparationBen McGinnes2018-10-031-0/+0
| | | | | | | | | * doc/Makefile.am: removed the python howto from this file, restoring it to just the main project and the newer .js files. * deleted: doc/gpgme-python-howto.texi * renamed the Short_History.org file to short-history.org to keep the naming conventions similar. * All the Python files can (and should) live together.
* python bindings: CPython orderBen McGinnes2018-10-021-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]>
* docs: python bindingsBen McGinnes2018-09-301-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]>
* docs: python bindings installationBen McGinnes2018-09-271-0/+67
| | | | | * lang/python/docs/gpgme-python-howto.org: added a section on installing the bindings to a python virtualenv.
* docs: a typographical two-stepBen McGinnes2018-09-251-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]>
* docs and examples: python bindingsBen McGinnes2018-09-241-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]>
* docs: python bindings howtoBen McGinnes2018-09-241-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.
* docs and examples: python bindings howtoBen McGinnes2018-09-231-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]>
* examples: python bindings and hkp4py updatesBen McGinnes2018-09-231-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.
* python bindings: importing from keyservers with hkp4pyBen McGinnes2018-09-221-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]>
* docs: python bindings howtoBen McGinnes2018-09-221-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]>
* docs: python bindings and its special requestBen McGinnes2018-09-201-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]>
* docs: python bindingsBen McGinnes2018-09-171-3/+7
| | | | | * Updated the Cython example code slightly, along with the corresponding explanation.
* docs: python bindings howtoBen McGinnes2018-09-171-20/+11
| | | | * Tightened up the Cython demonstration.
* docs: cython sanitizedBen McGinnes2018-09-161-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.
* docs: python bindings howtoBen McGinnes2018-09-161-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.
* docs: even more editsBen McGinnes2018-09-161-1/+1
| | | | | * doc/gpgme-python-howto.texi: hunting down and killing commas, Oxford or not it can't stay in a heading.
* docs: more editsBen McGinnes2018-09-161-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.
* docs: whitespace culledBen McGinnes2018-09-151-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.
* docs: renaming and draftsBen McGinnes2018-09-151-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.
* docs: Python howto updateBen McGinnes2018-09-151-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.
* Python bindings: docsBen McGinnes2018-09-151-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.
* docs: python bindingsBen McGinnes2018-08-311-2/+2
| | | | | | * minor typographic update. Signed-off-by: Ben McGinnes <[email protected]>
* docs: python bindings - protonmail examplesBen McGinnes2018-08-291-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.
* docs: python bindings HOWTOBen McGinnes2018-08-281-13/+24
| | | | | | * Finished CFFI vs SWIG bit in known issues. * tidied up some of the structure. * Fixed some minor errors and links.
* docs: python bindingsBen McGinnes2018-08-281-3/+22
| | | | * Added section on why no CFFI.
* docs: python howtoBen McGinnes2018-08-281-0/+94
| | | | * Added another key import example using ProtonMail's new keyserver.
* docs: python bindingsBen McGinnes2018-08-271-1/+157
| | | | * Added details on installation troubleshooting.
* docs: python bindings howtoBen McGinnes2018-07-221-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]>
* doc: python bindings howtoBen McGinnes2018-07-221-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.
* doc: python bindings howtoBen McGinnes2018-07-221-0/+1
| | | | * Added org-mode byline.
* docs: python bindings howtoBen McGinnes2018-07-091-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.
* python bindings: python 3.7Ben McGinnes2018-06-291-2/+6
| | | | | | | | * Bindings confirmed to work with the newly released 3.7.0. * Updated M4 file to reflect this change and correct the Python binary search order (3.7 is not yet given priority, but will still be found first via the more generic python3 executable). * Updated setup.py.in, bindings documentation and README to reflect this.
* docs: python bindings howtoBen McGinnes2018-06-281-0/+358
| | | | | * Updated official doc (the org-mode file) with the instructions on importing and exporting both public and secret keys.
* docs: python bindings howtoBen McGinnes2018-06-021-66/+73
| | | | | | | | | * Another attempt at fixing the org-mode version. * A proof reader ascertained there were tabs in it instead of whitespace. * Stripped the lot out and replaced with standard 4 spaces, fixed every incorrect example ... and it still breaks upon save and/or export. * Added the reference to the mutt-groups.py script to demonstrate the groups.py module/code.
* docs: python bindings howtoBen McGinnes2018-05-241-5/+7
| | | | | | | * Fixed the groups.py script so it really does what is described (the old code had the same result for groups, group_lines and group_lists). * Updated the corresponding example in the doc to match.
* doc: python bindings howtoBen McGinnes2018-05-241-3/+2
| | | | | | * Fixed org-mode python source indenting. ** Note: nested indented blocks do not indent correctly when exported to [X]HTML.
* docs and examples: python howtoBen McGinnes2018-05-231-5/+12
| | | | | | | | * Updated the decryption example code in the HOWTO and the corresponding decrypt-file.py script to gracefully handle a decryption failure. This error will always be triggered when GPGME is used to try to decrypt an old, MDC-less encrypted message or file.
* Merge branch 'master' of ssh+git://playfair.gnupg.org/git/gpgmeBen McGinnes2018-03-291-52/+88
|\ | | | | | | | | * Also fixed a small grammatical error highlighted by a merge conflict (in the python bindings howto).
| * docs: python bindings howtoBen McGinnes2018-03-281-25/+53
| | | | | | | | * Added section on revoking UIDs.
| * doc: python bindings howtoBen McGinnes2018-03-281-1/+1
| | | | | | | | * Fixed a typo.
| * docs python bindings howtoBen McGinnes2018-03-281-16/+19
| | | | | | | | | | * PEP8 compliance: a collection of minor edits across multiple example code snippets.
| * doc: python bindings howtoBen McGinnes2018-03-271-6/+6
| | | | | | | | * Fixed some minor PEP8 compliance issues in the key creation examples.
| * doc: python bindings howtoBen McGinnes2018-03-251-0/+1
| | | | | | | | | | | | | | | | * Testing the addition of a HTML header set in org-mode in order to had RSS update links for files. * This should work with any [X]HTML export from current versions of Org-Mode, but if it also works on website generated pages then it'll tick off one of the wishlist itmes.
| * doc: python bindings howtoBen McGinnes2018-03-251-0/+4
| | | | | | | | | | * Added a reference to new script which will setup a temporary homedir for a user.
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-28 23:11:59 +0000