Enable filter options support. jptd#1

Author: kiawin

.gitignore

@@ -60,3 +60,9 @@ target/
 
 # LibreOffice temporary files
 ~$*.odt
+
+# PyCharm
+.idea/
+
+# pyenv
+.python-version

.travis.yml

@@ -25,5 +25,5 @@ deploy:
   user: inductor
   on:
     condition: $TOXENV == py34-django19
-    repo: alexmorozov/templated-docs
+    repo: kiawin/templated-docs
     tags: true

AUTHORS.rst

@@ -10,4 +10,4 @@ Development Lead
 Contributors
 ------------
 
-None yet. Why not be the first?
+* Sian Lerk Lau <kiawin@gmail.com>

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/alexmorozov/templated-docs/issues.
+Report bugs at https://github.com/kiawin/templated-docs/issues.
 
 If you are reporting a bug, please include:
 
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/alexmorozov/templated-docs/issues.
+The best way to send feedback is to file an issue at https://github.com/kiawin/templated-docs/issues.
 
 If you are proposing a feature:
 
@@ -101,8 +101,8 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
-   https://travis-ci.org/alexmorozov/templated-docs/pull_requests
+3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4, 3.5, 3.6, 3.7 and for PyPy. Check
+   https://travis-ci.org/kiawin/templated-docs/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
@@ -112,3 +112,4 @@ To run a subset of tests::
 
 
     $ python -m unittest tests.test_templated_docs
+

README.rst

@@ -4,17 +4,17 @@ Templated-docs
 
 
 .. image:: https://badge.fury.io/py/templated-docs.svg
-        :target: https://pypi.python.org/pypi/templated_docs
+        :target: https://pypi.python.org/pypi/templateddocs
 
-.. image:: https://img.shields.io/travis/alexmorozov/templated-docs.svg
-        :target: https://travis-ci.org/alexmorozov/templated-docs
+.. image:: https://img.shields.io/travis/kiawin/templated-docs.svg
+        :target: https://travis-ci.org/kiawin/templated-docs
 
 .. image:: https://readthedocs.org/projects/templated-docs/badge/?version=latest
         :target: https://templated-docs.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status
 
-.. image:: https://requires.io/github/alexmorozov/templated-docs/requirements.svg?branch=master
-        :target: https://requires.io/github/alexmorozov/templated-docs/requirements?branch=master
+.. image:: https://requires.io/github/kiawin/templated-docs/requirements.svg?branch=master
+        :target: https://requires.io/github/kiawin/templated-docs/requirements?branch=master
         :alt: Dependencies
 
 
@@ -41,7 +41,7 @@ Example usage
 Create a ``sample.odt`` document (make sure it's in OpenDocument format) and
 put it in your Django templates folder. It should look something like this:
 
-.. image:: https://github.com/alexmorozov/templated-docs/raw/master/docs/document-template.png
+.. image:: https://github.com/kiawin/templated-docs/raw/master/docs/document-template.png
 
 Then write a view to generate documents from this template:
 
@@ -63,7 +63,7 @@ Then write a view to generate documents from this template:
 
 Navigate to the url your view is connected to, and you'll see a rendered and converted document:
 
-.. image:: https://github.com/alexmorozov/templated-docs/raw/master/docs/generated-document.png
+.. image:: https://github.com/kiawin/templated-docs/raw/master/docs/generated-document.png
 
 For more examples, see the ``examples/`` subfolder in the repository. More detailed documentation is available on https://templated-docs.readthedocs.io.
 
@@ -72,6 +72,8 @@ Credits
 
 Templated-docs was written by `Alex Morozov`_.
 
+As the repository is left idle for 2 years, `Sian Lerk Lau` has forked and resume the task of updating the module.
+
 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter

requirements_dev.txt

@@ -1,10 +1,10 @@
-pip==8.1.2
+pip==18.0.0
 bumpversion==0.5.3
 wheel==0.29.0
 watchdog==0.8.3
 flake8==2.6.2
 tox==2.3.1
 coverage==4.1
 Sphinx>=1.4,<1.5
-cryptography==1.4
+cryptography==2.3.1
 PyYAML==3.11

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.1
+current_version = 0.3.2
 commit = True
 tag = True
 tag_name = {new_version}

setup.py

@@ -21,20 +21,20 @@
 ]
 
 setup(
-    name='templated_docs',
-    version='0.3.1',
+    name='templateddocs',
+    version='0.3.2',
     description=('Generate PDF, MS Word and Excel documents from templates '
                  'in Django.'),
     long_description=readme + '\n\n' + history,
-    author="Alex Morozov",
-    author_email='alex@morozov.ca',
-    url='https://github.com/alexmorozov/templated-docs',
+    author="Sian Lerk Lau",
+    author_email='kiawin@gmail.com',
+    url='https://github.com/kiawin/templated-docs',
     packages=find_packages(),
     include_package_data=True,
     install_requires=requirements,
     license="MIT license",
     zip_safe=False,
-    keywords='templated_docs',
+    keywords='templateddocs',
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Developers',
@@ -46,6 +46,8 @@
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ],
     test_suite='tests.test_app.tests',
     tests_require=test_requirements

templated_docs/__init__.py

@@ -24,7 +24,7 @@
 import logging
 log = logging.getLogger(__name__)
 
-__version__ = '0.3.1'
+__version__ = '0.3.2'
 
 
 IMAGES_CONTEXT_KEY = '_templated_docs_imgs'
@@ -77,7 +77,7 @@ def find_template_file(template_name):
     raise TemplateDoesNotExist(template_name)
 
 
-def _convert_subprocess(filename, format, result_queue):
+def _convert_subprocess(filename, format, result_queue, options=None):
     """
     Subprocess helper to convert a file via LOKit.
 
@@ -93,16 +93,30 @@ def _convert_subprocess(filename, format, result_queue):
         conv_file = NamedTemporaryFile(delete=False,
                                        suffix='.%s' % format)
         with lo.documentLoad(filename) as doc:
-            doc.saveAs(str(conv_file.name))
+            doc.saveAs(str(conv_file.name), options=options)
         os.unlink(filename)
     result_queue.put(conv_file.name)
 
 
-def fill_template(template_name, context, output_format='odt'):
-    """
-    Fill a document with data and convert it to the requested format.
+def fill_template(template_name, context, output_format='odt', options=None):
+    """Fill a document with data and convert it to the requested format.
 
     Returns an absolute path to the generated file.
+
+    Supported output format:
+        Text documents: doc, docx, fodt, html, odt, ott, pdf, txt, xhtml, png
+        Spreadsheets: csv, fods, html, ods, ots, pdf, xhtml, xls, xlsx, png
+        Presentations: fodp, html, odg, odp, otp, pdf, potm, pot, pptx, pps, ppt, svg, swf, xhtml, png
+        Drawings: fodg, html, odg, pdf, svg, swf, xhtml, png
+
+    More on filter options, https://wiki.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Filter_Options
+
+    :param template_name: the path to template, in OpenDocument format
+    :param context: the context to be used to inject content
+    :param output_format: the output format
+    :param options: value of filterOptions in libreofficekit
+
+    :return:
     """
 
     if not isinstance(context, Context):
@@ -151,7 +165,7 @@ def fill_template(template_name, context, output_format='odt'):
     if source_extension[1:] != output_format:
         results = Queue()
         convertor = Process(target=_convert_subprocess,
-                            args=(str(dest_file.name), output_format, results))
+                            args=(str(dest_file.name), output_format, results, options))
         convertor.start()
         return results.get()
     else:

tox.ini

@@ -4,6 +4,7 @@ envlist = py{27,34}-django{18,19,110}, flake8
 [testenv:flake8]
 deps=flake8
 commands=flake8 templated_docs
+max-line-length=120
 
 [testenv]
 passenv = LO_PATH

travis_pypi_setup.py

@@ -21,7 +21,7 @@
     from urllib.request import urlopen
 
 
-GITHUB_REPO = 'alexmorozov/templated-docs'
+GITHUB_REPO = 'kiawin/templated-docs'
 TRAVIS_CONFIG_FILE = os.path.join(
     os.path.dirname(os.path.abspath(__file__)), '.travis.yml')