PyGPGME needs documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
PyGPGME |
In Progress
|
Medium
|
Unassigned |
Bug Description
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.
Changed in pygpgme: | |
importance: | Undecided → Medium |
status: | New → Confirmed |
Changed in pygpgme: | |
milestone: | none → 0.4 |
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.