Merge branch 'yohanboniface-optional-output-path' into dev

Author: JazzCore

README.rst

@@ -28,7 +28,7 @@ Installation
 .. code-block:: bash
 
 	$ sudo apt-get install wkhtmltopdf
-	
+
 * macOS:
 
 .. code-block:: bash
@@ -70,8 +70,8 @@ If you wish to further process generated PDF, you can read it to a variable:
 
 .. code-block:: python
 
-    # Use False instead of output path to save pdf to a variable
-    pdf = pdfkit.from_url('http://google.com', False)
+    # Without output_path, PDF is returned for assigning to a variable
+    pdf = pdfkit.from_url('http://google.com')
 
 You can specify all wkhtmltopdf `options <http://wkhtmltopdf.org/usage/wkhtmltopdf.txt>`_. You can drop '--' in option name. If option without value, use *None, False* or *''* for dict value:. For repeatable options (incl. allow, cookie, custom-header, post, postfile, run-script, replace) you may use a list or a tuple. With option that need multiple values (e.g. --custom-header Authorization secret) we may use a 2-tuple (see example below).
 

pdfkit/api.py

@@ -4,13 +4,13 @@
 from .pdfkit import Configuration
 
 
-def from_url(url, output_path, options=None, toc=None, cover=None,
+def from_url(url, output_path=None, options=None, toc=None, cover=None,
              configuration=None, cover_first=False):
     """
     Convert file of files from URLs to PDF document
 
     :param url: URL or list of URLs to be saved
-    :param output_path: path to output PDF file. False means file will be returned as string.
+    :param output_path: (optional) path to output PDF file. By default, PDF will be returned for assigning to a variable.
     :param options: (optional) dict with wkhtmltopdf global and page options, with or w/o '--'
     :param toc: (optional) dict with toc-specific wkhtmltopdf options, with or w/o '--'
     :param cover: (optional) string with url/filename with a cover html page
@@ -26,13 +26,13 @@ def from_url(url, output_path, options=None, toc=None, cover=None,
     return r.to_pdf(output_path)
 
 
-def from_file(input, output_path, options=None, toc=None, cover=None, css=None,
+def from_file(input, output_path=None, options=None, toc=None, cover=None, css=None,
               configuration=None, cover_first=False):
     """
     Convert HTML file or files to PDF document
 
     :param input: path to HTML file or list with paths or file-like object
-    :param output_path: path to output PDF file. False means file will be returned as string.
+    :param output_path: (optional) path to output PDF file. By default, PDF will be returned for assigning to a variable.
     :param options: (optional) dict with wkhtmltopdf options, with or w/o '--'
     :param toc: (optional) dict with toc-specific wkhtmltopdf options, with or w/o '--'
     :param cover: (optional) string with url/filename with a cover html page
@@ -49,13 +49,13 @@ def from_file(input, output_path, options=None, toc=None, cover=None, css=None,
     return r.to_pdf(output_path)
 
 
-def from_string(input, output_path, options=None, toc=None, cover=None, css=None,
+def from_string(input, output_path=None, options=None, toc=None, cover=None, css=None,
                 configuration=None, cover_first=False):
     """
     Convert given string or strings to PDF document
 
     :param input: string with a desired text. Could be a raw text or a html file
-    :param output_path: path to output PDF file. False means file will be returned as string.
+    :param output_path: (optional) path to output PDF file. By default, PDF will be returned for assigning to a variable.
     :param options: (optional) dict with wkhtmltopdf options, with or w/o '--'
     :param toc: (optional) dict with toc-specific wkhtmltopdf options, with or w/o '--'
     :param cover: (optional) string with url/filename with a cover html page