Skip to content

Various improvements #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 25, 2020
Merged

Various improvements #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
03ac98b
Fixed #29: using default values on Creator init
Jun 16, 2020
0080f58
Fixed #37: fixed __repr__ for ReadArticle and File, added on Article
Jun 16, 2020
70a74b1
Fixed #38: raising NotFound on unavailable article
Jun 16, 2020
2fb30e0
Fixed #30: get_metadata() now returns bytes
Jun 16, 2020
58d777f
Fixed #45: Creator now accepts pathlib for filename
Jun 16, 2020
94882c2
Cleaner writer API
Jun 24, 2020
52e9e38
Cleaner reader API
Jun 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions libzim/reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading