Extent pypi documentation. Set version to 0.2.2
[notmuch] / setup.py
1 #!/usr/bin/env python
2
3 from distutils.core import setup
4 from cnotmuch.notmuch import __VERSION__
5 setup(name='cnotmuch',
6       version=__VERSION__,
7       description='Python binding of the notmuch mail search and indexing library.',
8       author='Sebastian Spaeth',
9       author_email='Sebastian@SSpaeth.de',
10       url='http://bitbucket.org/spaetz/cnotmuch/',
11       download_url='http://bitbucket.org/spaetz/cnotmuch/get/v'+__VERSION__+'.tar.gz',
12       packages=['cnotmuch'],
13       keywords = ["library", "email"],
14       long_description="""Overview
15 ==============
16
17 The cnotmuch  module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing with a shared notmuch library. Notmuch provides a maildatabase that allows for extremely quick searching and filtering of your email according to various criteria.
18
19 The documentation for the latest cnotmuch release can be `viewed online <http://packages.python.org/cnotmuch>`_.
20
21 The classes notmuch.Database, notmuch.Query  provide most of the core functionality, returning notmuch.Messages and notmuch.Tags.
22
23 Installation and Deinstallation
24 -------------------------------
25
26 cnotmuch is packaged on http://pypi.python.org. This means you can do
27 "easy_install cnotmuch" (or using pip) on your linux box and it will
28 get installed into:
29
30 /usr/local/lib/python2.x/dist-packages/
31
32 For uninstalling, you will need to remove the "cnotmuch-0.1-py2.x.egg"
33 directory and delete one entry refering to cnotmuch in the
34 "easy-install.pth" file in that directory. There should be no trace
35 left of cnotmuch then.
36
37 Requirements
38 ------------
39
40 You need to have notmuch installed (or rather libnotmuch.so.1). The release version 0.1 should work fine. Also, cnotmuch makes use of the ctypes library, and has only been tested with python 2.5. It will not work on earlier python versions.
41 """,
42       classifiers=['Development Status :: 2 - Pre-Alpha',
43                    'Intended Audience :: Developers',
44                    'License :: OSI Approved :: GNU General Public License (GPL)',
45                    'Programming Language :: Python :: 2',
46                    'Programming Language :: Python :: 3',
47                    'Topic :: Communications :: Email',
48                    'Topic :: Software Development :: Libraries'
49                    ],
50       platforms='',
51       license='http://www.gnu.org/licenses/gpl-3.0.txt',
52      )