git.cworth.org Git - notmuch/blob - bindings/python/README

   1 notmuch -- The python interface to notmuch
   2 ==========================================
   3
   4 This module makes the functionality of the notmuch library
   5 (`https://notmuchmail.org`_) available to python. Successful import of
   6 this module depends on a libnotmuch.so|dll being available on the
   7 user's system.
   8
   9 If you have downloaded the full source tarball, you can create the
  10 documentation with sphinx installed, go to the docs directory and
  11 "make html". A static version of the documentation is available at:
  12
  13   https://notmuch.readthedocs.io/projects/notmuch-python/
  14
  15 To build the python bindings, do
  16
  17   python setup.py install --prefix=path/to/your/preferred/location