From: W. Trevor King <wking@drexel.edu>
Date: Thu, 22 Mar 2012 19:50:21 +0000 (-0400)
Subject: Add packaging (README and setup.py).
X-Git-Tag: v0.2~24
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=83a88388c49d9b1576fc21e0b125d27fe990d312;p=pyassuan.git

Add packaging (README and setup.py).
---

diff --git a/README b/README
new file mode 100644
index 0000000..4f3ef05
--- /dev/null
+++ b/README
@@ -0,0 +1,92 @@
+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``, which offers a
+number of advantages::
+
+__ wrappers_
+
+* No need to spawn ``gpg`` every time you want to do something
+  cryptographic.
+* No need to `do anything fancy with file descriptors`__ to verify
+  detached signatures.
+
+__ enable-special-filenames_
+
+Installation
+============
+
+Packages
+--------
+
+Gentoo
+~~~~~~
+
+I've packaged ``pyassuan`` for Gentoo_.  You need layman_ and
+my `wtk overlay`_.  Install with::
+
+  # emerge -av app-portage/layman
+  # layman --add wtk
+  # emerge -av dev-python/pyassuan
+
+Dependencies
+------------
+
+``pyassuan`` is a simple package with no external dependencies outside
+the Python 3 standard library.
+
+Installing by hand
+------------------
+
+``pgp-mime`` is available as a Git_ repository::
+
+  $ git clone git://tremily.us/pgp-mime.git
+
+See the homepage_ for details.  To install the checkout, run the
+standard::
+
+  $ python setup.py install
+
+Usage
+=====
+
+Checkout the docstrings and the examples in ``bin``.
+
+Testing
+=======
+
+Run the internal unit tests using nose_::
+
+  $ nosetests --with-doctest --doctest-tests pgp-mime
+
+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
+
+Licence
+=======
+
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
+
+Author
+======
+
+W. Trevor King
+wking@drexel.edu
+
+
+.. _Assuan: http://www.gnupg.org/documentation/manuals/assuan/
+.. _GnuPG: http://www.gnupg.org/
+.. _wrappers: http://wiki.python.org/moin/GnuPrivacyGuard
+.. _enable-special-filenames:
+  http://lists.gnupg.org/pipermail/gnupg-devel/2002-November/019343.html
+.. _Gentoo: http://www.gentoo.org/
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
+.. _Git: http://git-scm.com/
+.. _homepage: http://blog.tremily.us/posts/pyassuan/
+.. _nose: http://readthedocs.org/docs/nose/en/latest/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.html
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..4ed8d97
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,36 @@
+# Copyright
+
+"Python module and tools for communicating in the Assuan protocol."
+
+from distutils.core import setup as _setup
+import os.path as _os_path
+
+from pyassuan import __version__
+
+
+_this_dir = _os_path.dirname(__file__)
+
+_setup(
+    name='pyassuan',
+    version=__version__,
+    maintainer='W. Trevor King',
+    maintainer_email='wking@drexel.edu',
+    url='http://blog.tremily.us/posts/pyassuan/',
+    download_url='http://git.tremily.us/?p=pyassuan.git;a=snapshot;h=v{};sf=tgz'.format(__version__),
+    license = 'GNU General Public License (GPL)',
+    platforms = ['all'],
+    description = __doc__,
+    long_description=open(_os_path.join(_this_dir, 'README'), 'r').read(),
+    classifiers = [
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Operating System :: OS Independent',
+        'License :: OSI Approved :: GNU General Public License (GPL)',
+        'Programming Language :: Python :: 3',
+        'Topic :: Security :: Cryptography',
+        'Topic :: Software Development'
+        ],
+    scripts = ['bin/get-info.py', 'bin/pinentry.py'],
+    packages = ['pyassuan'],
+    provides = ['pyassuan'],
+    )