README

   1 Python module and tools for communicating in the Assuan_ protocol.
   2
   3 There are a number of GnuPG_ wrappers for python `out there`__, but
   4 they mostly work via the ``gpg`` executable.  This is an attempt to
   5 cut to the chase and speak directly to ``gpg-agent``.  Unfortunately,
   6 ``gpg`` only uses ``gpg-agent`` for passphrase caching, not
   7 encryption.  This means that speaking directly to ``gpg-agent``
   8 doesn't help you do much cryptography.
   9
  10 __ wrappers_
  11
  12 Installation
  13 ============
  14
  15 Packages
  16 --------
  17
  18 Gentoo
  19 ~~~~~~
  20
  21 I've packaged ``pyassuan`` for Gentoo_.  You need layman_ and
  22 my `wtk overlay`_.  Install with::
  23
  24   # emerge -av app-portage/layman
  25   # layman --add wtk
  26   # emerge -av dev-python/pyassuan
  27
  28 Dependencies
  29 ------------
  30
  31 ``pyassuan`` is a simple package with no external dependencies outside
  32 the Python 3 standard library.
  33
  34 Installing by hand
  35 ------------------
  36
  37 ``pgp-mime`` is available as a Git_ repository::
  38
  39   $ git clone git://tremily.us/pgp-mime.git
  40
  41 See the homepage_ for details.  To install the checkout, run the
  42 standard::
  43
  44   $ python setup.py install
  45
  46 Usage
  47 =====
  48
  49 Checkout the docstrings and the examples in ``bin``.
  50
  51 Testing
  52 =======
  53
  54 Run the internal unit tests using nose_::
  55
  56   $ nosetests --with-doctest --doctest-tests pgp-mime
  57
  58 If a Python-3-version of ``nosetests`` is not the default on your
  59 system, you may need to try something like::
  60
  61   $ nosetests-3.2 --with-doctest --doctest-tests pgp-mime
  62
  63 To test running servers by hand, you can use `gpg-connect-agent`_.
  64 Despite the name, this program can connect to any Assuan server::
  65
  66   $ gpg-connect-agent --raw-socket name
  67
  68 Licence
  69 =======
  70
  71 This project is distributed under the `GNU General Public License
  72 Version 3`_ or greater.
  73
  74 Author
  75 ======
  76
  77 W. Trevor King
  78 wking@tremily.us
  79
  80
  81 .. _Assuan: http://www.gnupg.org/documentation/manuals/assuan/
  82 .. _GnuPG: http://www.gnupg.org/
  83 .. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard
  84 .. _enable-special-filenames:
  85   http://lists.gnupg.org/pipermail/gnupg-devel/2002-November/019343.html
  86 .. _Gentoo: http://www.gentoo.org/
  87 .. _layman: http://layman.sourceforge.net/
  88 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  89 .. _Git: http://git-scm.com/
  90 .. _homepage: http://blog.tremily.us/posts/pyassuan/
  91 .. _nose: http://readthedocs.org/docs/nose/en/latest/
  92 .. _gpg-connect-agent:
  93   http://www.gnupg.org/documentation/manuals/gnupg-devel/gpg_002dconnect_002dagent.html
  94 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html