--HG--
extra : transplant_source : %3F%E9%23%2B%2A%83%06g%10R%CA%CD%27N5%3E%22g%1E%AD
import ctypes
from ctypes import c_int, c_char_p
import ctypes
from ctypes import c_int, c_char_p
-from database import Database,Tags,Query
+from database import Database,Tags,Query,Messages,Message,Tags
from cnotmuch.globals import nmlib,STATUS,NotmuchError
# 114 typedef struct _notmuch_query notmuch_query_t;
from cnotmuch.globals import nmlib,STATUS,NotmuchError
# 114 typedef struct _notmuch_query notmuch_query_t;
master_doc = 'index'
# General information about the project.
master_doc = 'index'
# General information about the project.
copyright = u'2010, Sebastian Spaeth'
# The version info for the project you're documenting, acts as replacement for
copyright = u'2010, Sebastian Spaeth'
# The version info for the project you're documenting, acts as replacement for
-.. notmuch documentation master file, created by
+.. cnotmuch documentation master file, created by
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
-.. currentmodule:: notmuch.notmuch
+.. currentmodule:: cnotmuch.notmuch
Welcome to notmuch's documentation!
===================================
Welcome to notmuch's documentation!
===================================
-The :mod:`notmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality. The main work horse of this module is the class :class:`Notmuch` with important other classes representing a :class:`Thread` and a single :class:`Message`.
+The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
+The classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Messages` and :class:`Tags`.
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
-:License: This module is covered under the GNU GPL v2 (or later).
+:License: This module is covered under the GNU GPL v3 (or later).
-This page contains the main API overview. More information on specific topics can be found on the following pages:
+This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
+
+Notmuch can be imported as:
+
+ from cnotmuch import notmuch
+
+or:
+
+ from cnotmuch.notmuch import Query,Database
.. toctree::
:maxdepth: 1
.. toctree::
:maxdepth: 1
:mod:`notmuch` -- The Notmuch interface
=============================================
:mod:`notmuch` -- The Notmuch interface
=============================================
-:class:`Message` -- A single email message
-------------------------------------
+Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
+:class:`Database` -- The underlying notmuch database
+-----------------------------------------------------
+
+.. autoclass:: Database
-:class:`Thread` -- Represents a message thread
+:class:`Query` -- Represents a notmuch Query
-----------------------------------------------
-----------------------------------------------
:members:
.. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
:members:
.. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
-:class:`Notmuch` -- A notmuch call
-------------------------------------
+:class:`Messages` -- A bunch of messages
+----------------------------------------
+
+.. autoclass:: Messages
+ :members:
+
+:class:`Message` -- A single message
+----------------------------------------
+
+.. autoclass:: Message
+ :members:
+
+:class:`Tags` -- A bunch of notmuch tags
+----------------------------------------
:members:
.. data: '__notmuchcmd__'
:members:
.. data: '__notmuchcmd__'