gpgme/lang/gpygme/docs
Ben McGinnes fd045bbe7b Apparently not then ...
* Cannot include local copies of CC licenses at this time, not even the
  original HTML versions.  Still have links in the README.org file at
  least.
2015-06-27 06:09:42 +10:00
..
Australian_DCTA_export_DECO_Questionnaire_Results.pdf Dual Use export exemption 2015-06-24 19:15:33 +10:00
Australian_DCTA_export_DECO_Questionnaire_Results.pdf.sig Dual Use export exemption 2015-06-24 19:15:33 +10:00
FAQ.org Typesetting 2015-06-27 03:27:10 +10:00
README.org Selected CC license for documentation 2015-06-27 05:52:51 +10:00

GPyGME

Project Goal

Intended as both a replacement of the older PyME bindings for Python 2 and Python 3, though it will only be implemented in Python 3. Some effort may be made to allow it to work as a module or series of modules in Python 2, but there are no guarantees.

GPyGME is intended to be the official API for third party (i.e. non-C) languages and bindings. While it should be able to be imported into any Python 3 code as a normal Python module or library, this is not the principal goal. The real value is in providing an API for everyone by providing a pseudo-REST style API. It is not actually a REST API because it is not purely web-based, though could be implemented that way (and almost certainly will be by many).

GPyGME will accept and respond with JSON data types to provide a method of interaction with GPGME with which most, if not all, modern application developers are familiar. Consequently the bindings ought to be usable by anyone for any purpose for which GPGME could meet the need.

Project Name

GPyGME, with the first "G" being silent is pronounced the same way as pygme. It could be thought of as a diminutive form of GPGME with the ability to unlock just as much power.

Licensing

GPyGME utilises the LGPL 2.1+ license, the same as GPGME itself. It may also include some tools or sample code licensed under the GPL 2.0 or 3.0. Any such code will be marked clearly as such. Documentation will be covered by both the GPLv3+ as with the GPGME documentation and the Creative Commons Attribution-ShareAlike 3.0 Unported Public License (CC BY-SA 3.0) and the Attribution-ShareAlike 4.0 International Public License (CC BY-SA 4.0).

Contributions to GPyGME require the same licensing and assurances be granted the project as are presently required by GPGME. Specifically that authors agree to license their contributions under both the LGPL version 2.1 and the GPL version 2.0; using the "or any later" clause in both cases. Documentation authors are required to include the matching both the Creative Commons BY-SA 3.0 and 4.0 licenses in addition to the GPL and LGPL.

While we do not request the copyright of these contributions be signed over to the Free Software Foundation, we do request developers and authors include a signed copy of the GPGME Developers' Certificate of Origin (DCO) as per the instructions provided with the GPGME documentation. See the hacking document for more details.

Note that interacting with the GPyGME API as a stand alone interface (i.e. sending and receiving JSON data to it via a socket, command or other connection type) does not require conforming with either the GPL or LGPL licenses. Only when importing or integrating this code into your own application does that become a requirement.

Feedback

GPyGME is written and maintained by Ben McGinnes, but discussion ought to be conducted on the gnupg-devel mailing list.