Merge pull request #47 from openzim/rgaudin/various_impr

Author: mgautierfr

libzim/reader.py

@@ -1,4 +1,16 @@
-# flake8: noqa
+""" libzim reader module
+
+    - File to open and read ZIM files
+    - Article are returned by File on get_article() and get_article_by_id()
+    - NotFound is raised on incorrect article URL query
+
+    Usage:
 
-from .wrapper import FilePy as File
+    with File(pathlib.Path("myfile.zim")) as zf:
+        article = zf.get_article(zf.main_page_url)
+        print(f"Article {article.title} at {article.url} is {article.content.nbytes}b")
+    """
+
+# flake8: noqa
+from .wrapper import FilePy as File, NotFound
 from .wrapper import ReadArticle as Article