Skip to content

Commit

Permalink
Bump version, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mportesdev committed Mar 2, 2021
1 parent 78d25d6 commit 4682ec0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
30 changes: 15 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,22 +111,16 @@ Result:

Using the ``pictures_to_pdf`` shortcut function:

.. code-block:: python
from pictureshow import pictures_to_pdf
pictures_to_pdf('pics/mandelbrot.png', 'pics/mandelbrot.jpg', 'pictures.pdf')
The example above will work as long as the output file is passed as the last positional argument. It is however recommended to always use a keyword argument:

.. code-block:: python
from pictureshow import pictures_to_pdf
list_of_pictures = ['pics/mandelbrot.png', 'pics/mandelbrot.jpg']
pictures_to_pdf(*list_of_pictures, pdf_file='pictures.pdf')
Another example, demonstrating all available keyword parameters:
Please note that unlike the command line interface, ``pdf_file`` must be specified as a keyword argument:

Another example, demonstrating all available keyword-only arguments:

.. code-block:: python
Expand All @@ -150,19 +144,25 @@ Result:

.. image:: https://raw.githubusercontent.com/mportesdev/pictureshow/master/pics/sample_pdf_oldies.png

Notable changes
~~~~~~~~~~~~~~~

**version 0.3.2**

The ``page_size`` and ``layout`` arguments can now be specified either by a string (just like in the command line interface) or by a sequence of two numbers. For example, ``page_size='LETTER', layout='2x3'`` is equivalent to ``page_size=(72 * 8.5, 72 * 11), layout=(2, 3)``.

*New in version 0.3.2*
**version 0.3.6**

The ``page_size`` and ``layout`` parameters can be specified either by a string (just like in the command line interface) or by a sequence of two numbers. For example, ``page_size='LETTER', layout='2x3'`` is equivalent to ``page_size=(72 * 8.5, 72 * 11), layout=(2, 3)``.
The ``pdf_file`` argument can now be specified either by a string (just like in the command line interface) or by a path-like object.

*New in version 0.3.6*
**version 0.4.0**

The ``pdf_file`` parameter can be specified either by a string (just like in the command line interface) or by a path-like object.
``pdf_file`` is now a required keyword-only argument of the ``pictures_to_pdf`` function. All positional arguments are treated as paths to input picture files.

Footnotes
~~~~~~~~~

.. [#] Note that glob patterns are not expanded by the Windows command line shell.
.. [#] Please note that glob patterns are not expanded by the Windows command line shell.
.. [#] 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,
Expand All @@ -175,7 +175,7 @@ Footnotes
.. |pylint| image:: https://github.com/mportesdev/pictureshow/workflows/pylint/badge.svg
:target: https://github.com/mportesdev/pictureshow/actions
.. |release| image:: https://img.shields.io/github/v/release/mportesdev/pictureshow.svg
:target: https://github.com/mportesdev/pictureshow/releases/tag/0.3.7
:target: https://github.com/mportesdev/pictureshow/releases/tag/0.4.0
.. |license| image:: https://img.shields.io/github/license/mportesdev/pictureshow.svg
:target: https://github.com/mportesdev/pictureshow/blob/master/LICENSE
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/pictureshow
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 PageSizeError, MarginError, LayoutError
from pictureshow.core import PictureShow, pictures_to_pdf

__version__ = '0.3.7'
__version__ = '0.4.0'

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

0 comments on commit 4682ec0

Please sign in to comment.