diff options
author | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:18:54 +0100 |
---|---|---|
committer | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:18:54 +0100 |
commit | 8dfbba05fa43013e9c97d94246c167c3d64a9d50 (patch) | |
tree | bc803e5212deef67a9b5df6734230fdf653d479a /bindings/python/docs/source/quickstart.rst | |
parent | fb52083bf7eff44f27b2f2fffcbfbcb4faaeda3c (diff) |
python: move the usage example to quickstart.rst
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings/python/docs/source/quickstart.rst')
-rw-r--r-- | bindings/python/docs/source/quickstart.rst | 19 |
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) |