Metadata-Version: 2.1
Name: assuan
Version: 0.2.1b1
Summary: Python module and tools for communicating in the Assuan protocol.
Author-email: "Jesse P. Johnson" <jpj6652@gmail.com>, "W. Trevor King" <wking@tremily.us>
Maintainer-email: "Jesse P. Johnson" <jpj6652@gmail.com>
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development
Requires-Dist: build>=0.7.0,<1 ; extra == "dev"
Requires-Dist: wheel>=0.37.1,<1 ; extra == "dev"
Requires-Dist: proman-versioning>=0.5.0-alpha.2 ; extra == "dev"
Requires-Dist: flake8>=3.8.3,<4 ; extra == "dev"
Requires-Dist: mypy>=0.942,<1 ; extra == "dev"
Requires-Dist: pylint>=2.9.5,<3 ; extra == "dev"
Requires-Dist: click==8.0.4 ; extra == "dev"
Requires-Dist: flit>=3,<4 ; extra == "dev"
Requires-Dist: black==22.1.0 ; extra == "dev"
Requires-Dist: isort>=5.9.2,<6 ; extra == "dev"
Requires-Dist: bandit>=1.6.2 ; extra == "dev"
Requires-Dist: safety>=1.9 ; extra == "dev"
Requires-Dist: pytest>=7 ; extra == "dev"
Requires-Dist: pytest-cov>=2.10 ; extra == "dev"
Requires-Dist: tox>=3.24.0,<4 ; extra == "dev"
Requires-Dist: sphinx>=5.3 ; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.19.5 ; extra == "docs"
Requires-Dist: doc8>=0.11.2,<1 ; extra == "docs"
Requires-Dist: docstr-coverage>=1.2.0,<2 ; extra == "docs"
Requires-Dist: pydocstyle[toml]>=6.1.1,<7 ; extra == "docs"
Project-URL: repository, https://github.com/pygpg/assuan.git
Provides-Extra: dev
Provides-Extra: docs

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 ``gpgme-tool`` (source__) over
a well-defined socket protocol.

__ wrappers_
__ gpgme-tool_

Installation
============

Dependencies
------------

``assuan`` is a simple package with no external dependencies outside
the Python 3.6+ standard library.

Contributing
------------

``assuan`` is available as a Git_ repository::

  $ git clone https://github.com/pygpg/assuan.git

See the homepage_ for details.  To install the checkout, run the
standard::

  $ pip install -e .[dev]

Usage
=====

Checkout the docstrings and the examples in ``bin``.

Testing
=======

Run the internal unit tests with pytest::

  $ python -m pytest

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
=======

This project is distributed under the `GNU General Public License
Version 3`_ or greater.

Author
======

Jesse P. Johnson <jpj6652@gmail.com>
W. Trevor King <wking@tremily.us>

References
==========

.. _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
.. _Git: http://git-scm.com/
.. _homepage: http://blog.tremily.us/posts/pyassuan/
.. _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

