aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/quickstart.rst
diff options
context:
space:
mode:
authorDavid Bremner <bremner@debian.org>2012-04-04 23:27:01 -0300
committerDavid Bremner <bremner@debian.org>2012-04-04 23:27:01 -0300
commit4adefd4c497a1977db36317ed34c406565fb201d (patch)
tree1d1d7c6cea688d8ef71f70a9a022165f60be3140 /bindings/python/docs/source/quickstart.rst
parent954cf155718a5a7576a7a578d836b76e15d312a4 (diff)
parent331f0cac61802606e0103c35453656d2299cbfe3 (diff)
Merge tag 'debian/0.12-1' into squeeze-backports
notmuch Debian 0.12-1 upload (same as 0.12 + debian changelog fix) Conflicts: debian/changelog
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 00000000..609f42e1
--- /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)