From 85d7b0e2c171ace69481f4a2e84bffe38c62be38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Porte=C5=A1?= Date: Fri, 29 Apr 2022 10:46:51 +0200 Subject: [PATCH] Update README, bump version to 0.7.1 --- README.rst | 30 +++++++++++------------------- pictureshow/__init__.py | 2 +- 2 files changed, 12 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index 5029151..1823ac8 100644 --- a/README.rst +++ b/README.rst @@ -3,12 +3,10 @@ Save pictures to PDF from the command line or from your Python programs. -Requirements -============ +Prerequisites +============= - Python 3.7 or higher -- `Pillow `__ -- `reportlab `__ Installation @@ -18,6 +16,10 @@ Installation pip install pictureshow +The third-party dependencies of this package are +`reportlab `__ and +`Pillow `__. + Usage ===== @@ -67,15 +69,15 @@ Save single picture to PDF: .. code:: - $ pictureshow pics/potato.jpg potato.pdf + $ pictureshow pics/potato.jpg -o potato.pdf Saved 1 picture (1 page) to 'potato.pdf' Save multiple pictures, four pictures per page (two columns, two rows), -set page to landscape Letter-sized [#]_: +set page orientation to landscape: .. code:: - $ pictureshow --page-size=LETTER --landscape --layout=2x2 photos/* photos + $ pictureshow -l 2x2 -L photos/* -o photos Saved 50 pictures (13 pages) to 'photos.pdf' (Please note that if the target filename has no extension specified, @@ -85,8 +87,8 @@ Save pictures from URLs, set smaller margin and stretch small pictures: .. code:: - $ pictureshow --margin=36 --stretch-small https:// https:// https:// pics_from_web - Saved 3 pictures (3 pages) to 'pics_from_web.pdf' + $ pictureshow -m 36 -s https:// https:// -o pics_from_web + Saved 2 pictures (2 pages) to 'pics_from_web.pdf' As a Python library @@ -153,16 +155,6 @@ default values correspond to the above shown command line options: ) -Footnotes -========= - -.. [#] Available page sizes are: - A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, - B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, - C0, C1, C2, C3, C4, C5, C6, C7, C8, C9, C10, - LETTER, LEGAL, ELEVENSEVENTEEN, - JUNIOR_LEGAL, HALF_LETTER, GOV_LETTER, GOV_LEGAL, TABLOID, LEDGER - .. |build-test| image:: https://github.com/mportesdev/pictureshow/actions/workflows/build-test.yml/badge.svg :target: https://github.com/mportesdev/pictureshow/actions .. |coverage| image:: https://img.shields.io/codecov/c/gh/mportesdev/pictureshow diff --git a/pictureshow/__init__.py b/pictureshow/__init__.py index b42b6ff..ced0164 100644 --- a/pictureshow/__init__.py +++ b/pictureshow/__init__.py @@ -1,7 +1,7 @@ from .exceptions import PageSizeError, MarginError, LayoutError from .core import PictureShow, pictures_to_pdf -__version__ = '0.7.0' +__version__ = '0.7.1' __all__ = ['__version__', 'PictureShow', 'pictures_to_pdf', 'PageSizeError', 'MarginError', 'LayoutError']