aboutsummaryrefslogtreecommitdiff
path: root/contrib/python-legacy/README
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2025-02-15 15:30:43 -0400
committerDavid Bremner <david@tethera.net>2025-02-22 07:01:47 -0400
commitd526797ad198e394bb8b4909f43976b76fb347f1 (patch)
treeb924eefb8a1278afb988387a67e9fe413738003e /contrib/python-legacy/README
parent9782c8651192c1496541bd8949b7991c41528b3f (diff)
python: move legacy python bindings to contrib.
This forces us to verify the build and test suite completes without the legacy python bindings. As of this commit the legacy python bindings are unsupported by notmuch. They are provided in contrib/ for now, but will most likely eventually be removed from there as well. We recommend that downstream/distro packagers phase out their packages for the legacy python bindings.
Diffstat (limited to 'contrib/python-legacy/README')
-rw-r--r--contrib/python-legacy/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/contrib/python-legacy/README b/contrib/python-legacy/README
new file mode 100644
index 00000000..5bf076d2
--- /dev/null
+++ b/contrib/python-legacy/README
@@ -0,0 +1,17 @@
+notmuch -- The python interface to notmuch
+==========================================
+
+This module makes the functionality of the notmuch library
+(`https://notmuchmail.org`_) available to python. Successful import of
+this module depends on a libnotmuch.so|dll being available on the
+user's system.
+
+If you have downloaded the full source tarball, 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:
+
+ https://notmuch.readthedocs.io/projects/notmuch-python/
+
+To build the python bindings, do
+
+ python setup.py install --prefix=path/to/your/preferred/location