-cnotmuch -- The python interface to notmuch.so
-==============================================
+Notmuch - thread-based email index, search and tagging.
-This module makes the functionality of the notmuch library
-(`http://notmuchmail.org`_) available to python. Successful import of
-this modul depends on a libnotmuch.so|dll being available on the
-user's system.
+Notmuch is a system for indexing, searching, reading, and tagging
+large collections of email messages in maildir or mh format. It uses
+the Xapian library to provide fast, full-text search with a convenient
+search syntax.
-If you have downloaded the full source tarball (available from
-bitbucket.org, the source distribution and binary distribution come
-without the documentation), you can create the documentation with
-sphinx installed, go to the docs directory and "make html". A static
-version of the documentation is available at:
+Notmuch is free software, released under the GNU General Public
+License version 3 (or later).
-http://packages.python.org/cnotmuch/
+Building notmuch
+----------------
+See the INSTALL file for notes on compiling and installing notmuch.
-The current source code is being hosted at
-http://bitbucket.org/spaetz/cnotmuch which also provides an issue
-tracker, and release downloads. This package is tracked by the python
-package index repository at `http://pypi.python.org/pypi/cnotmuch`_ and can thus be installed on a user's computer easily via "sudo easy_install cnotmuch" (you will still need to install the notmuch shared library separately as it is not included in this package).
+Contacting users and developers
+-------------------------------
+The website for Notmuch is:
-The original source has been provided by (c)Sebastian Spaeth, 2010.
-All code is available under the GNU GPLv3+ (see docs/COPYING) unless specified otherwise.
+ http://notmuchmail.org
+The mailing list address for the notmuch community is:
-INSTALLATION & DEINSTALL
-------------------------
+ notmuch@notmuchmail.org
-cnotmuch is available on pypi.python.org. This means you can do
-"easy_install cnotmuch" on your linux box and it will get installed
-into:
+We welcome any sort of questions, comments, kudos, or code there.
-/usr/local/lib/python2.x/dist-packages/
+Subscription is not required, (but if you do subscribe you'll avoid
+any delay due to moderation). See the website for subscription
+information.
-For uninstalling, you'll need to remove the "cnotmuch-0.1-py2.x.egg"
-directory and delete one entry in the "easy-install.pth" file in that
-directory.
+There is also an IRC channel dedicated to talk about using and
+developing notmuch:
-It needs to have a libnotmuch.so or libnotmuch.so.1 available in some
-library folder or will raise an exception when loading.
-"OSError: libnotmuch.so.1: cannot open shared object file: No such file or directory"
+ IRC server: irc.freenode.net
+ Channel: #notmuch
+Interface options
+-----------------
+Notmuch includes a "notmuch" command-line interface to the system.
+This is not a very convenient interface and it is not expected that
+users will find it satisfying. Instead, there are two option for
+obtaining a more sophisticated interface:
-Usage
------
-For more examples of how to use the cnotmuch interface, have a look at the
-notmuch "binary" and the generated documentation.
+ 1. Build on top of the "notmuch" command-line interface.
-Example session:
->>>from cnotmuch import notmuch
->>>db = notmuch.Database("/home/spaetz/mail")
-db.get_path()
-'/home/spaetz/mail'
->>>tags = db.get_all_tags()
->>>for tag in tags:
->>> print tag
-inbox
-...
-maildir::draft
-#---------------------------------------------
+ This might be a reasonable option for a very text-oriented
+ client environment. For example, an emacs-based interface for
+ notmuch is already under development and is available in the
+ notmuch.el file in this distribution.
-q = notmuch.Query(db,'from:Sebastian')
-count = len(q.search_messages())
-1300
+ If someone were to write a curses-based interface, or similar,
+ it might also be reasonable to build on the "notmuch"
+ command-line interface.
-#---------------------------------------------
+ 2. Build on top of the notmuch library interface.
->>>db = notmuch.Database("/home/spaetz/mailHAHA")
-NotmuchError: Could not open the specified database
+ This is a better choice for developing an interface that has
+ full control of the presentation of email threads and
+ messages. It is expected that anyone integrating Notmuch into
+ an existing, graphical email program use the notmuch library
+ interface.
-#---------------------------------------------
+ The public interface to the notmuch library is contained in
+ the notmuch.h header file. The "notmuch" command-line program
+ in notmuch.c can be used as good example code, since it is a
+ simple program that is written on top of the library
+ interface.
->>>tags = notmuch.Database("/home/spaetz/mail").get_all_tags()
->>>del(tags)
-
-
-Changelog
----------
-0.1 First public release
-0.1.1 Fixed Database.create_query()
-0.2.0 Implemented Thread() and Threads() methods
\ No newline at end of file
+As can be seen, alternate interfaces to the Notmuch mail system are
+still in development. We would appreciate any contributions to these
+efforts.
projects / notmuch / blobdiff