change custom configuration setting

Author: JazzCore

README.rst

@@ -131,7 +131,7 @@ You can also pass any options through meta tags in your HTML:
 Configuration
 -------------
 
-Each API call takes an optional configuration paramater. This should be an instance of ``pdfkit.configuration.Configuration()`` - it takes the configuration options as initial paramaters. The available options are:
+Each API call takes an optional configuration paramater. This should be an instance of ``pdfkit.configuration()`` API call. It takes the configuration options as initial paramaters. The available options are:
 
 * ``wkhtmltopdf`` - the location of the ``wkhtmltopdf`` binary. By default ``pdfkit`` will attempt to locate this using ``which`` (on UNIX type systems) or ``where`` (on Windows).
 * ``meta_tag_prefix`` - the prefix for ``pdfkit`` specific meta tags - by default this is ``pdfkit-``
@@ -140,7 +140,7 @@ Example - for when ``wkhtmltopdf`` is not on ``$PATH``:
 
 .. code-block:: python
 
-    config = pdfkit.configuration.Configuration(wkhtmltopdf='/opt/bin/wkhtmltopdf'))
+    config = pdfkit.configuration(wkhtmltopdf='/opt/bin/wkhtmltopdf'))
     pdfkit.from_string(html_string, output_file, configuration=config)
 
 

pdfkit/__init__.py

@@ -8,5 +8,4 @@
 __license__ = 'MIT'
 
 from .pdfkit import PDFKit
-from .api import from_url, from_file, from_string
-from .configuration import Configuration
+from .api import from_url, from_file, from_string, configuration

pdfkit/api.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from .pdfkit import PDFKit
+from .pdfkit import Configuration
 
 
 def from_url(url, output_path, options=None, toc=None, cover=None, configuration=None):
@@ -65,3 +66,14 @@ def from_string(input, output_path, options=None, toc=None, cover=None, css=None
                configuration=configuration)
 
     return r.to_pdf(output_path)
+
+
+def configuration(**kwargs):
+    """
+    Constructs and returns a :class:`Configuration` with given options
+
+    :param wkhtmltopdf: path to binary
+    :param meta_tag_prefix: the prefix for ``pdfkit`` specific meta tags
+    """
+
+    return Configuration(**kwargs)

pdfkit/pdfkit.py

@@ -11,6 +11,8 @@
 
 class PDFKit(object):
     """
+    Main class that does all generation routine.
+
     :param url_or_file: str - either a URL, a path to a file or a string containing HTML
                        to convert
     :param type_: str - either 'url', 'file' or 'string'

tests/pdfkit-tests.py

@@ -47,6 +47,14 @@ def test_options_parsing_with_dashes(self):
         r = pdfkit.PDFKit('html', 'string', options={'--page-size': 'Letter'})
         self.assertTrue(r.options['--page-size'])
 
+    def test_custom_configuration(self):
+        conf = pdfkit.configuration()
+        self.assertEqual('pdfkit-', conf.meta_tag_prefix)
+        conf = pdfkit.configuration(meta_tag_prefix='prefix-')
+        self.assertEqual('prefix-', conf.meta_tag_prefix)
+        with self.assertRaises(IOError):
+            conf = pdfkit.configuration(wkhtmltopdf='wrongpath')
+
 
 class TestPDFKitCommandGeneration(unittest.TestCase):
     """Test command() method"""