converting readme to rst and fixing setup.py

Author: samuelcolvin

.travis.yml

@@ -13,11 +13,12 @@ matrix:
   - python: 'nightly'
 
 install:
-- pip install coverage flake8
+- pip install coverage flake8 Pygments docutils
 
 script:
 - coverage run --source=pydf setup.py test
-- flake8 --max-line-length 120 pydf/
+- flake8 pydf/
+- python setup.py check -rms
 - python setup.py install
 - tests/check_file_permissions.py
 - python -c "import pydf; print(pydf.get_version())"

README.md

@@ -0,0 +1,113 @@
+pydf
+====
+
+
+|Build Status| |codecov.io| |PyPI Status| |license|
+
+PDF generation in python using
+`wkhtmltopdf <http://wkhtmltopdf.org/>`__.
+
+Wkhtmltopdf binaries are precompiled and included in the package making
+pydf easier to use, in particular this means pydf works on heroku.
+
+Currently using **wkhtmltopdf 0.12.4 (with patched qt)**.
+
+Install
+-------
+
+::
+
+    pip install python-pdf
+
+(pydf was taken, but I guess python-pdf is a clearer name anyway.)
+
+Changelog
+---------
+
+0.3
+~~~
+
+-  uprev wkhtmltopdf from **0.12.2 (beta)** to **0.12.4**.
+-  code cleanup
+
+Basic Usage
+-----------
+
+.. code:: python
+
+    import pydf
+    pdf = pydf.generate_pdf('<h1>this is html</h1>')
+    with open('test_doc.pdf', 'w') as f:
+        f.write(pdf)
+
+    pdf = pydf.generate_pdf('www.google.com')
+    with open('google.pdf', 'w') as f:
+        f.write(pdf)
+
+API
+---
+
+**generate\_pdf(source, [\*\*kwargs])**
+
+Generate a pdf from either a url or a html string.
+
+After the html and url arguments all other arguments are passed straight
+to wkhtmltopdf
+
+For details on extra arguments see the output of get\_help() and
+get\_extended\_help()
+
+All arguments whether specified or caught with extra\_kwargs are
+converted to command line args with
+``'--' + original_name.replace('_', '-')``.
+
+Arguments which are True are passed with no value eg. just --quiet,
+False and None arguments are missed, everything else is passed with
+str(value).
+
+**Arguments:**
+
+-  ``source``: html string to generate pdf from or url to get
+-  ``quiet``: bool
+-  ``grayscale``: bool
+-  ``lowquality``: bool
+-  ``margin_bottom``: string eg. 10mm
+-  ``margin_left``: string eg. 10mm
+-  ``margin_right``: string eg. 10mm
+-  ``margin_top``: string eg. 10mm
+-  ``orientation``: Portrait or Landscape
+-  ``page_height``: string eg. 10mm
+-  ``page_width``: string eg. 10mm
+-  ``page_size``: string: A4, Letter, etc.
+-  ``image_dpi``: int default 600
+-  ``image_quality``: int default 94
+-  ``extra_kwargs``: any exotic extra options for wkhtmltopdf
+
+Returns string representing pdf
+
+**get\_version()**
+
+Get version of pydf and wkhtmltopdf binary
+
+**get\_help()**
+
+get help string from wkhtmltopdf binary uses -h command line option
+
+**get\_extended\_help()**
+
+get extended help string from wkhtmltopdf binary uses -H command line
+option
+
+**execute\_wk(\*args)**
+
+Low level function to call wkhtmltopdf, arguments are added to
+wkhtmltopdf binary and passed to subprocess with not processing.
+
+.. |Build Status| image:: https://travis-ci.org/samuelcolvin/pydf.svg?branch=master
+   :target: https://travis-ci.org/samuelcolvin/pydf
+.. |codecov.io| image:: http://codecov.io/github/samuelcolvin/pydf/coverage.svg?branch=master
+   :target: http://codecov.io/github/samuelcolvin/pydf?branch=master
+.. |PyPI Status| image:: https://img.shields.io/pypi/v/pydf.svg?style=flat
+   :target: https://pypi.python.org/pypi/pydf
+.. |license| image:: https://img.shields.io/pypi/l/pydf.svg
+   :target: https://github.com/samuelcolvin/pydf

README.rst

@@ -1,2 +1,6 @@
 [bdist_wheel]
 universal = 1
+
+[flake8]
+max-complexity = 10
+max-line-length = 120

setup.cfg

@@ -1,13 +1,11 @@
-import sys
 import os
 from setuptools import setup
 from setuptools.command.install import install
 
 description = 'PDF generation in python using wkhtmltopdf suitable for heroku'
-long_description = description
-if 'upload' in sys.argv or 'register' in sys.argv:
-    import pypandoc
-    long_description = pypandoc.convert('README.md', 'rst')
+THIS_DIR = os.path.dirname(os.path.abspath(__file__))
+with open(os.path.join(THIS_DIR, 'README.rst')) as f:
+    long_description = f.read()
 
 
 class OverrideInstall(install):