Is there documentation/user manual for this?

Asked by Joel Auterson on 2010-04-02

Is there such a thing as documentation or a user manual for this project? I'd like to use it as a Python module.

Question information

English Edit question
gkeyring Edit question
No assignee Edit question
Solved by:
Joel Auterson
Last query:
Last reply:
Kamil Páral (kamil.paral) said : #1

The only current documentation is "gkeyring --help".

If you want to use gkeyring features from a Python script, just have a look at the "gnomekeyring" module. Because gkeyring is nothing but a shell wrapper to gnomekeyring module. gnomekeyring will provide you with everything you might need and it will be easier for you to use.

Kamil Páral (kamil.paral) said : #2

Have a look at gkeyring's source code to see some examples how to use gnomekeyring module. It's quite easy when you get the basics how Gnome Keyring works. Unfortunately the documentation of gnomekeyring is really scarce, usually you have to read the C library documentation.

Joel Auterson (joel-auterson) said : #3

Thanks. Where can I find Python docs for that module? All i can find is C.

Kamil Páral (kamil.paral) said : #4

I usually use ipython to import the keyring and inspect the methods available, it at least shows the number of arguments and their names. Not much, I know. The rest of it you must read up from C documentation (and bend it a little to cover the Python's differences).

Joel Auterson (joel-auterson) said : #5

I will try ipython. I have no knowledge of C whatsoever.