Skip to content

Commit

Permalink
Update README, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
mportesdev committed Dec 15, 2020
1 parent c52a4e9 commit c55d364
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,25 +39,26 @@ Simple example — saving a single picture to PDF:
$ pictureshow picture.png pic.pdf
Saved 1 picture to '/.../pic.pdf'
Using a glob pattern, in the quiet mode:
Using a glob pattern, setting page to landscape Letter-sized:

.. code::
$ pictureshow -q *.jpg jpg_pics.pdf
$ pictureshow --page-size=LETTER -L *.jpg jpg_pics.pdf
Saved 4 pictures to '/.../jpg_pics.pdf'
Using multiple glob patterns, with half-inch margin and 1x3 pictures per page:

.. code::
$ pictureshow --margin=36 --layout=1x3 *.png *.jpg *.gif all_pics.pdf
Saved 32 pictures to '/.../all_pics.pdf'
Saved 9 pictures to '/.../all_pics.pdf'
Combining glob pattern and additional filenames, overwriting existing output file, stretching small pictures to page, with zero margin:

.. code::
$ pictureshow chart.gif *.jpg figure.png pics.pdf -fsm0
Saved 7 pictures to '/.../pics.pdf'
Saved 6 pictures to '/.../pics.pdf'
As a Python library
-------------------
Expand Down Expand Up @@ -88,7 +89,7 @@ The example above will work as long as the output file is passed as the last pos
list_of_pictures = ['pic1.png', 'pic2.jpg', 'pic3.gif']
pictures_to_pdf(*list_of_pictures, pdf_file='pictures.pdf')
Another example, with landscape page orientation, half-inch margin and 2x2 pictures per page, stretching small pictures to area, overwriting target file if it exists:
Another example, with all available keyword parameters — A5-sized page, landscape orientation, half-inch margin, 2x2 pictures per page, stretching small pictures to area, overwriting target file if it exists:

.. code-block:: python
Expand All @@ -100,6 +101,7 @@ Another example, with landscape page orientation, half-inch margin and 2x2 pictu
pictures_to_pdf(
*list_of_pictures,
pdf_file='screenshots.pdf',
page_size='A5',
landscape=True,
margin=36,
layout=(2, 2),
Expand Down
2 changes: 1 addition & 1 deletion pictureshow/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from pictureshow.exceptions import MarginError, PageSizeError
from pictureshow.core import PictureShow, pictures_to_pdf

__version__ = '0.3.0'
__version__ = '0.3.1'

__all__ = ['__version__', 'PictureShow', 'pictures_to_pdf',
'MarginError', 'PageSizeError']

0 comments on commit c55d364

Please # to comment.