aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/quickstart.rst
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-08-06 18:10:31 +0200
committerAnton Khirnov <anton@khirnov.net>2012-08-06 18:10:31 +0200
commit7192d0221a361d3d9cfd6626058e4a1c86ea7b44 (patch)
tree11d3db0604f47498e16b50ef7f559e138bfe4482 /bindings/python/docs/source/quickstart.rst
parent6bc2f5a999d9ff77779d98b7cc688a4350ea65d9 (diff)
parent6b820673fc9c2483572af5ec7ea91e4d7d7258c9 (diff)
Merge remote-tracking branch 'origin/master' into vim
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)