doc: python bindings todo list

* Checked off several points of howto coverage as completed.
* Reorganised to move S/MIME coverage to its own separate group of tasks.
* Noted only revocation remains for howto completion.
This commit is contained in:
Ben McGinnes 2018-03-19 12:46:41 +11:00
parent 1779d7b9d6
commit bf67cf433f

View File

@ -28,6 +28,7 @@
to produce reST versions via Pandoc and DITA XML can be reached to produce reST versions via Pandoc and DITA XML can be reached
through converting to either Markdown or XHTML first. through converting to either Markdown or XHTML first.
** STARTED Documentation HOWTO ** STARTED Documentation HOWTO
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: todo-docs-howto :CUSTOM_ID: todo-docs-howto
@ -43,48 +44,57 @@
:CUSTOM_ID: howto-start :CUSTOM_ID: howto-start
:END: :END:
*** STARTED Include certain specific instructions in the HOWTO *** STARTED Include certain specific instructions in the HOWTO
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: howto-requests :CUSTOM_ID: howto-requests
:END: :END:
Note: moved the S/MIME bits out to their own section of the TODO
list and may be served better by separate HOWTO documentation
anyway.
- State "STARTED" from "TODO" [2018-03-09 Fri 15:27] - State "STARTED" from "TODO" [2018-03-09 Fri 15:27]
Some functions can be worked out from the handful of examples Some functions can be worked out from the handful of examples
available, but many more can't and I've already begun receiving available, but many more can't and I've already begun receiving
requests for certain functions to be explained. requests for certain functions to be explained.
**** STARTED Standard scenarios
**** DONE Standard scenarios
CLOSED: [2018-03-19 Mon 12:34]
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: howto-the-basics :CUSTOM_ID: howto-the-basics
:END: :END:
- State "DONE" from "STARTED" [2018-03-19 Mon 12:34] \\
All four of those are done.
- State "STARTED" from "TODO" [2018-03-09 Fri 15:26] \\ - State "STARTED" from "TODO" [2018-03-09 Fri 15:26] \\
Began with the example code, now to add the text. Began with the example code, now to add the text.
What everyone expects: encryption, decryption, signing and verifying. What everyone expects: encryption, decryption, signing and verifying.
**** TODO Key control
**** STARTED Key control
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: howto-key-control :CUSTOM_ID: howto-key-control
:END: :END:
- State "STARTED" from "TODO" [2018-03-19 Mon 12:35] \\
Generating keys and subkeys are done, but revocation is still to be done.
Generating keys, adding subkeys, revoking subkeys (and keeping Generating keys, adding subkeys, revoking subkeys (and keeping
the cert key), adding and revoking UIDs, signing/certifying keys. the cert key), adding and revoking UIDs, signing/certifying keys.
**** TODO More key control
**** DONE More key control
CLOSED: [2018-03-19 Mon 12:36]
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: howto-key-selection :CUSTOM_ID: howto-key-selection
:END: :END:
- State "DONE" from "TODO" [2018-03-19 Mon 12:36] \\
Key selection, searching, matching and counting is done.
Selecting keys to encrypt to or manipulate in other ways (e.g. as Selecting keys to encrypt to or manipulate in other ways (e.g. as
with key control or the basics). with key control or the basics).
**** TODO S/MIME
:PROPERTIES:
:CUSTOM_ID: howto-s-mime
:END:
Eventually add some of this, but the OpenPGP details are far more
important at the moment.
** TODO Documentation SWIG ** TODO Documentation SWIG
:PROPERTIES: :PROPERTIES:
@ -98,6 +108,7 @@
something to be used in conjunction with the existing GPGME something to be used in conjunction with the existing GPGME
documentation which makes it easier for Python developers to use. documentation which makes it easier for Python developers to use.
** TODO GUI examples ** TODO GUI examples
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: todo-gui-examples :CUSTOM_ID: todo-gui-examples
@ -107,6 +118,7 @@
to either match or be similar to the old GTK2 examples available to either match or be similar to the old GTK2 examples available
with PyME. with PyME.
** TODO Replace SWIG ** TODO Replace SWIG
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: todo-replace-swig :CUSTOM_ID: todo-replace-swig
@ -122,6 +134,7 @@
bindings using a more suitable means of interfacing with the GPGME bindings using a more suitable means of interfacing with the GPGME
C source code. C source code.
*** TODO Replacement for SWIG *** TODO Replacement for SWIG
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: todo-replace-swig-replacement :CUSTOM_ID: todo-replace-swig-replacement
@ -131,6 +144,7 @@
the most viable candidate, but some additional testing and checks the most viable candidate, but some additional testing and checks
are yet to be completed. are yet to be completed.
** TODO API for an API ** TODO API for an API
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: todo-api-squared :CUSTOM_ID: todo-api-squared
@ -146,6 +160,15 @@
bindings. bindings.
** TODO S/MIME
:PROPERTIES:
:CUSTOM_ID: s-mime
:END:
Eventually add some of this, but the OpenPGP details are far more
important at the moment.
* Project Task Details * Project Task Details
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: detailed-tasks :CUSTOM_ID: detailed-tasks