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``, which offers a
   6 number of advantages::
   7
   8 __ wrappers_
   9
  10 * No need to spawn ``gpg`` every time you want to do something
  11   cryptographic.
  12 * No need to `do anything fancy with file descriptors`__ to verify
  13   detached signatures.
  14
  15 __ enable-special-filenames_
  16
  17 Installation
  18 ============
  19
  20 Packages
  21 --------
  22
  23 Gentoo
  24 ~~~~~~
  25
  26 I've packaged ``pyassuan`` for Gentoo_.  You need layman_ and
  27 my `wtk overlay`_.  Install with::
  28
  29   # emerge -av app-portage/layman
  30   # layman --add wtk
  31   # emerge -av dev-python/pyassuan
  32
  33 Dependencies
  34 ------------
  35
  36 ``pyassuan`` is a simple package with no external dependencies outside
  37 the Python 3 standard library.
  38
  39 Installing by hand
  40 ------------------
  41
  42 ``pgp-mime`` is available as a Git_ repository::
  43
  44   $ git clone git://tremily.us/pgp-mime.git
  45
  46 See the homepage_ for details.  To install the checkout, run the
  47 standard::
  48
  49   $ python setup.py install
  50
  51 Usage
  52 =====
  53
  54 Checkout the docstrings and the examples in ``bin``.
  55
  56 Testing
  57 =======
  58
  59 Run the internal unit tests using nose_::
  60
  61   $ nosetests --with-doctest --doctest-tests pgp-mime
  62
  63 If a Python-3-version of ``nosetests`` is not the default on your
  64 system, you may need to try something like::
  65
  66   $ nosetests-3.2 --with-doctest --doctest-tests pgp-mime
  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@drexel.edu
  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 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html