git.notmuchmail.org Git - notmuch/blob - bindings/python/setup.py

   1 #!/usr/bin/env python
   2
   3 import os
   4 from distutils.core import setup
   5
   6 # get the notmuch version number without importing the notmuch module
   7 version_file = os.path.join(os.path.dirname(os.path.abspath(__file__)),
   8                             'notmuch', 'version.py')
   9 exec(compile(open(version_file).read(), version_file, 'exec'))
  10 assert __VERSION__, 'Failed to read the notmuch binding version number'
  11
  12 setup(name='notmuch',
  13       version=__VERSION__,
  14       description='Python binding of the notmuch mail search and indexing library.',
  15       author='Sebastian Spaeth',
  16       author_email='Sebastian@SSpaeth.de',
  17       url='http://notmuchmail.org/',
  18       download_url='http://notmuchmail.org/releases/notmuch-'+__VERSION__+'.tar.gz',
  19       packages=['notmuch'],
  20       keywords = ["library", "email"],
  21       long_description="""Overview
  22 ==============
  23
  24 The notmuch  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.
  25
  26 The documentation for the latest cnotmuch release can be `viewed online <http://packages.python.org/notmuch>`_.
  27
  28 The classes notmuch.Database, notmuch.Query  provide most of the core functionality, returning notmuch.Messages and notmuch.Tags.
  29
  30 Installation and Deinstallation
  31 -------------------------------
  32
  33 notmuch is included in the upstream notmuch source repository and it is
  34 packaged on http://pypi.python.org. This means you can do "easy_install
  35 notmuch" (or using pip) on your linux box and it will get installed
  36 into:
  37
  38 /usr/local/lib/python2.x/dist-packages/
  39
  40 For uninstalling, you will need to remove the "notmuch-0.x-py2.x.egg"
  41 directory and delete one entry refering to cnotmuch in the
  42 "easy-install.pth" file in that directory. There should be no trace
  43 left of cnotmuch then.
  44
  45 Requirements
  46 ------------
  47
  48 You need to have notmuch installed (or rather libnotmuch.so.1). Also,
  49 notmuch makes use of the ctypes library, and has only been tested with
  50 python >= 2.5. It will not work on earlier python versions.
  51 """,
  52       classifiers=['Development Status :: 3 - Alpha',
  53                    'Intended Audience :: Developers',
  54                    'License :: OSI Approved :: GNU General Public License (GPL)',
  55                    'Programming Language :: Python :: 2',
  56                    'Programming Language :: Python :: 3',
  57                    'Topic :: Communications :: Email',
  58                    'Topic :: Software Development :: Libraries'
  59                    ],
  60       platforms='',
  61       license='http://www.gnu.org/licenses/gpl-3.0.txt',
  62      )