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 ``gpgme-tool`` (source__) over
   6 a well-defined socket protocol.
   7
   8 __ wrappers_
   9 __ gpgme-tool_
  10
  11 Installation
  12 ============
  13
  14 Packages
  15 --------
  16
  17 Gentoo
  18 ~~~~~~
  19
  20 I've packaged ``pyassuan`` for Gentoo_.  You need layman_ and
  21 my `wtk overlay`_.  Install with::
  22
  23   # emerge -av app-portage/layman
  24   # layman --add wtk
  25   # emerge -av dev-python/pyassuan
  26
  27 Dependencies
  28 ------------
  29
  30 ``pyassuan`` is a simple package with no external dependencies outside
  31 the Python 3.3 standard library.
  32
  33 Installing by hand
  34 ------------------
  35
  36 ``pyassuan`` is available as a Git_ repository::
  37
  38   $ git clone git://tremily.us/pyassuan.git
  39
  40 See the homepage_ for details.  To install the checkout, run the
  41 standard::
  42
  43   $ python setup.py install
  44
  45 Usage
  46 =====
  47
  48 Checkout the docstrings and the examples in ``bin``.
  49
  50 Testing
  51 =======
  52
  53 Run the internal unit tests with `Python 3.2+'s unittest discovery`__::
  54
  55   $ python -m unittest discover
  56
  57 To test running servers by hand, you can use `gpg-connect-agent`_.
  58 Despite the name, this program can connect to any Assuan server::
  59
  60   $ gpg-connect-agent --raw-socket name
  61
  62 __ unittest-discovery_
  63
  64 Licence
  65 =======
  66
  67 This project is distributed under the `GNU General Public License
  68 Version 3`_ or greater.
  69
  70 Author
  71 ======
  72
  73 W. Trevor King
  74 wking@tremily.us
  75
  76
  77 .. _Assuan: http://www.gnupg.org/documentation/manuals/assuan/
  78 .. _GnuPG: http://www.gnupg.org/
  79 .. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard
  80 .. _gpgme-tool:
  81   http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gpgme.git;a=blob;f=src/gpgme-tool.c;hb=HEAD
  82 .. _Gentoo: http://www.gentoo.org/
  83 .. _layman: http://layman.sourceforge.net/
  84 .. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
  85 .. _Git: http://git-scm.com/
  86 .. _homepage: http://blog.tremily.us/posts/pyassuan/
  87 .. _gpg-connect-agent:
  88   http://www.gnupg.org/documentation/manuals/gnupg-devel/gpg_002dconnect_002dagent.html
  89 .. _unittest-discovery:
  90   https://docs.python.org/3.5/library/unittest.html#unittest-test-discovery
  91 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html