PyGPGME needs documentation

[Tim Allen]

I've been looking for a Python GPG wrapper for a while now, and PyGPGME seems well-written with a nice API, but it's ridiculously difficult to figure out how to get started since the documentation is so poor.

Having spent an afternoon in trial and error and reading source, I decided I should write up some API documentation. I've only documented a few methods and properties on the Context class so far — partially because I'm not confident I understand the entire API, partially because I'd like feedback before I going on. At any rate, it shouldn't be difficult to write the rest of the docs, just tedious.

I've formatted the docs so they look reasonable in the output of "pydoc gpgme" and pydoc's HTML output. You could probably get something prettier with epydoc or pydoctor, but pydoc was handy.

[James Henstridge (jamesh)]

The patch has been applied as a start for the docs. I'll look at extending and improving it to cover more of the API.

[Samuel Einan Santi (redshadow-t)]

I am working on this for the same reason as OP: pygpgme seems the only decent way to use GPG from Python, but the lack of documentation is frustrating.

I started adding docstrings as well (and temporarily put code on https://github.com/rshk/pygpgme/ as I have no clue on how to use bazaar) as the initial idea was to generate documentation with Sphinx's autodoc, but apparently something didn't work and documentation doesn't get extracted properly.

At the end, I decided to write "plain" documentation using Sphinx (which, while requiring docs and code to stay in two different places, allows for a more "descriptive" documentation, documenting constants / attributes, etc.).

It is still work in progress, but you can find the current version here: http://pygpgme.readthedocs.org/en/latest/

Help is very welcome (and I'm going to send a pull request here once I look up how to do that).