From 8dfbba05fa43013e9c97d94246c167c3d64a9d50 Mon Sep 17 00:00:00 2001
From: Justus Winter <4winter@informatik.uni-hamburg.de>
Date: Fri, 24 Feb 2012 01:18:54 +0100
Subject: python: move the usage example to quickstart.rst

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
---
 bindings/python/docs/source/quickstart.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 bindings/python/docs/source/quickstart.rst

(limited to 'bindings/python/docs/source/quickstart.rst')

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)
-- 
cgit v1.2.3