aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/quickstart.rst
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/python/docs/source/quickstart.rst')
-rw-r--r--bindings/python/docs/source/quickstart.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/bindings/python/docs/source/quickstart.rst b/bindings/python/docs/source/quickstart.rst
new file mode 100644
index 0000000..609f42e
--- /dev/null
+++ b/bindings/python/docs/source/quickstart.rst
@@ -0,0 +1,19 @@
+Quickstart and examples
+=======================
+
+.. todo:: write a nice introduction
+.. todo:: improve the examples
+
+Notmuch can be imported as::
+
+ import notmuch
+
+or::
+
+ from notmuch import Query, Database
+
+ db = Database('path', create=True)
+ msgs = Query(db, 'from:myself').search_messages()
+
+ for msg in msgs:
+ print(msg)