X-Git-Url: http://git.tremily.us/?p=pyassuan.git;a=blobdiff_plain;f=README;h=014880eb05e302d0f14088286a303d2405824a77;hp=ea35602ff7ea17c7ee89adcabb6935726e45d4a1;hb=3994d26220e57c6dd6b66e85e4c1d6a843baa9d7;hpb=fc986422255fd3deed93a26a4ba9cbd479524d54 diff --git a/README b/README index ea35602..014880e 100644 --- a/README +++ b/README @@ -2,12 +2,11 @@ Python module and tools for communicating in the Assuan_ protocol. There are a number of GnuPG_ wrappers for python `out there`__, but they mostly work via the ``gpg`` executable. This is an attempt to -cut to the chase and speak directly to ``gpg-agent``. Unfortunately, -``gpg`` only uses ``gpg-agent`` for passphrase caching, not -encryption. This means that speaking directly to ``gpg-agent`` -doesn't help you do much cryptography. +cut to the chase and speak directly to ``gpgme-tool`` (source__) over +a well-defined socket protocol. __ wrappers_ +__ gpgme-tool_ Installation ============ @@ -29,14 +28,14 @@ Dependencies ------------ ``pyassuan`` is a simple package with no external dependencies outside -the Python 3 standard library. +the Python 3.3 standard library. Installing by hand ------------------ -``pgp-mime`` is available as a Git_ repository:: +``pyassuan`` is available as a Git_ repository:: - $ git clone git://tremily.us/pgp-mime.git + $ git clone git://tremily.us/pyassuan.git See the homepage_ for details. To install the checkout, run the standard:: @@ -53,12 +52,17 @@ Testing Run the internal unit tests using nose_:: - $ nosetests --with-doctest --doctest-tests pgp-mime + $ nosetests --with-doctest --doctest-tests pyassuan If a Python-3-version of ``nosetests`` is not the default on your system, you may need to try something like:: - $ nosetests-3.2 --with-doctest --doctest-tests pgp-mime + $ nosetests-3.2 --with-doctest --doctest-tests pyassuan + +To test running servers by hand, you can use `gpg-connect-agent`_. +Despite the name, this program can connect to any Assuan server:: + + $ gpg-connect-agent --raw-socket name Licence ======= @@ -70,12 +74,14 @@ Author ====== W. Trevor King -wking@drexel.edu +wking@tremily.us .. _Assuan: http://www.gnupg.org/documentation/manuals/assuan/ .. _GnuPG: http://www.gnupg.org/ .. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard +.. _gpgme-tool: + http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gpgme.git;a=blob;f=src/gpgme-tool.c;hb=HEAD .. _enable-special-filenames: http://lists.gnupg.org/pipermail/gnupg-devel/2002-November/019343.html .. _Gentoo: http://www.gentoo.org/ @@ -84,4 +90,6 @@ wking@drexel.edu .. _Git: http://git-scm.com/ .. _homepage: http://blog.tremily.us/posts/pyassuan/ .. _nose: http://readthedocs.org/docs/nose/en/latest/ +.. _gpg-connect-agent: + http://www.gnupg.org/documentation/manuals/gnupg-devel/gpg_002dconnect_002dagent.html .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html