9b042d999a93249eca64e5f92351c932692ddadf
[gpgme.git] / lang / python / docs / TODO.org
1 #+TITLE: Stuff To Do
2 #+LATEX_COMPILER: xelatex
3 #+LATEX_CLASS: article
4 #+LATEX_CLASS_OPTIONS: [12pt]
5 #+LATEX_HEADER: \usepackage{xltxtra}
6 #+LATEX_HEADER: \usepackage[margin=1in]{geometry}
7 #+LATEX_HEADER: \setmainfont[Ligatures={Common}]{Latin Modern Roman}
8
9 * Project Task List
10   :PROPERTIES:
11   :CUSTOM_ID: task-list
12   :END:
13
14 ** DONE Documentation default format
15    CLOSED: [2018-02-15 Thu 21:29]
16    :PROPERTIES:
17    :CUSTOM_ID: todo-docs-default
18    :END:
19
20    Decide on a default file format for documentation.  The two main
21    contenders being Org Mode, the default for the GnuPG Project and
22    reStructuredText, the default for Python projects.  A third option
23    of DITA XML was considered due to a number of beneficial features
24    it provides.
25
26    The decision was made to use Org Mode in order to fully integrate
27    with the rest of the GPGME and GnuPG documentation.  It is possible
28    to produce reST versions via Pandoc and DITA XML can be reached
29    through converting to either Markdown or XHTML first.
30
31 ** TODO Documentation HOWTO
32    :PROPERTIES:
33    :CUSTOM_ID: todo-docs-howto
34    :END:
35
36    Write a HOWTO style guide for the current Python bindings.
37
38 *** TODO Start python bindings HOWTO
39     :PROPERTIES:
40     :CUSTOM_ID: howto-start
41     :END:
42
43 ** TODO Documentation SWIG
44    :PROPERTIES:
45    :CUSTOM_ID: todo-docs-swig
46    :END:
47
48    Write documentation for the complete SWIG bindings demonstrating
49    the correspondence with GPGME itself.
50
51    Note: it is likely that this will be more in the nature of
52    something to be used in conjunction with the existing GPGME
53    documentation which makes it easier for Python developers to use.
54
55 ** TODO GUI examples
56    :PROPERTIES:
57    :CUSTOM_ID: todo-gui-examples
58    :END:
59
60    Create some examples of using Python bindings in a GUI application
61    to either match or be similar to the old GTK2 examples available
62    with PyME.
63
64 ** TODO Replace SWIG
65    :PROPERTIES:
66    :CUSTOM_ID: todo-replace-swig
67    :END:
68
69    Selecting SWIG for this project in 2002 was understandable and
70    effectively the only viable option.  The options available now,
71    however, are significantly improved and some of those would resolve
72    a number of existing problems with using SWIG, particularly when
73    running code on both POSIX compliant and Windows platforms.
74
75    The long term goal is to replace SWIG by reimplementing the Python
76    bindings using a more suitable means of interfacing with the GPGME
77    C source code.
78
79 *** TODO Replacement for SWIG
80     :PROPERTIES:
81     :CUSTOM_ID: todo-replace-swig-replacement
82     :END:
83
84     Decide on a replacement for SWIG.  Currently CFFI is looking like
85     the most viable candidate, but some additional testing and checks
86     are yet to be completed.
87
88 ** TODO API for an API
89    :PROPERTIES:
90    :CUSTOM_ID: todo-api-squared
91    :END:
92
93    A C API like GPGME is not what most modern developers think of when
94    they hear the term API. Normally they think of something they can
95    interact with like a RESTful web API.  Though RESTful is unlikely
96    given the nature of GPGME and the process of encryption, it may be
97    possible to provide a more familiar interface which can be utilised
98    by developers of other languages for which bindings are not
99    available or for which it is too difficult to create proper
100    bindings.
101
102
103 * Project Task Details
104   :PROPERTIES:
105   :CUSTOM_ID: detailed-tasks
106   :END:
107
108 ** Working examples
109    :PROPERTIES:
110    :CUSTOM_ID: working-examples
111    :END:
112
113    The old GUI examples were unable to be retained since they depended
114    on GTK2 and Python 2's integration with GTK2.
115
116    Current GPGME examples so far only include command line tools or
117    basic Python code for use with either Python 2.7 or Python 3.4 and
118    above.
119
120    Future GUI examples ought to utilise available GUI modules and
121    libraries supported by Python 3.  This may include Qt frameworks,
122    Tkinter, GTK3 or something else entirely.
123
124 ** Documentation
125    :PROPERTIES:
126    :CUSTOM_ID: documentation
127    :END:
128
129    The legacy documentation which no longer applies to the Python
130    bindings has been removed.
131
132    Current and future documentation will adhere to the GnuPG standard
133    of using Org Mode and not use the reStructuredText (reST) format
134    more commonly associated with Python documentation.  The reasons
135    for this are that this project is best served as shipping with the
136    rest of GPGME and the documentation ought to match that.  There are
137    also aspects of Org Mode's publishing features which are superior
138    to the defaults of reST, including the capacity to generate fully
139    validating strict XHTML output.
140
141    If reST files are required at a later point for future inclusion
142    with other Python packages, then that format can be generated from
143    the .org files with Pandoc before being leveraged by either
144    Docutils, Sphinx or something else.
145
146    While there are some advanced typesetting features of reST which
147    are not directly available to Org Mode, more often than not those
148    features are best implemented with either HTML and CSS, with LaTeX
149    to produce a PDF or via a number of XML solutions.  Both reST and
150    Org Mode have multiple paths by which to achieve all of these.