new wkthmltopdf, also uprev python in server (#22)

* new wkthmltopdf, also uprev python in server

* uprev version

* New wkhtmltopdf

* Switch to GH Actions (#27)

* Switch to GH Actions

* Update test reqs

* Install black

* Remove travis

* Add versioning script to publish to pypi

Co-authored-by: tomhamiltonstubber <[email protected]>

Author: samuelcolvin

.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '**'
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: set up python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.9'
+
+    - name: install dependencies
+      run: |
+        sudo apt install libjpeg62 libc6
+        make install
+        pip freeze
+
+    - name: test
+      run: |
+        chmod +x /home/runner/work/pydf/pydf/pydf/bin/wkhtmltopdf
+        make lint
+        make test
+        make benchmark
+        python -c "import pydf; print(pydf.get_version())"
+
+    - name: codecov
+      run: bash <(curl -s https://codecov.io/bash)
+
+  deploy:
+    needs:
+      - test
+    if: "success() && startsWith(github.ref, 'refs/tags/')"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: set up python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.9'
+
+      - name: install
+        run: |
+          pip install -U pip setuptools wheel twine
+          pip install .
+      - name: set version
+        run: VERSION_PATH='pydf/version.py' python <(curl -Ls https://git.io/JT3rm)
+
+      - run: python setup.py sdist bdist_wheel
+
+      - run: twine check dist/*
+
+      - name: upload to pypi
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.pypi_token }}

.travis.yml

@@ -1,11 +1,11 @@
-FROM python:3.6
+FROM python:3.8
 
-RUN pip install aiohttp==2.1.0
+LABEL maintainer='[email protected]'
+
+RUN pip install aiohttp==3.7.3
 ADD ./pydf /pydf
 ADD setup.py /
 RUN pip install -e .
 
-LABEL maintainer '[email protected]'
-
 ADD ./docker-entrypoint.py /
 ENTRYPOINT ["/docker-entrypoint.py"]

Dockerfile

@@ -1,19 +1,23 @@
+black = black -S -l 120 --target-version py38
+isort = isort -w 120
+
 .PHONY: install
 install:
 	pip install -U setuptools pip
 	pip install -U .
 	pip install -r tests/requirements.txt
 
-.PHONY: isort
-isort:
-	isort -rc -w 120 pydf
-	isort -rc -w 120 tests
+.PHONY: format
+format:
+	$(isort) pydf tests
+	$(black) pydf tests
 
 .PHONY: lint
 lint:
 	python setup.py check -rms
-	flake8 pydf/ tests/
-	pytest pydf -p no:sugar -q
+	flake8 pydf tests
+	$(isort) --check-only pydf tests
+	$(black) --check pydf tests
 
 .PHONY: test
 test:

Makefile

@@ -162,3 +162,17 @@ wkhtmltopdf binary and passed to subprocess with not processing.
    :target: https://github.com/tutorcruncher/pydf
 .. |docker| image:: https://img.shields.io/docker/automated/samuelcolvin/pydf.svg
    :target: https://hub.docker.com/r/samuelcolvin/pydf/
+
+
+Heroku
+-------
+
+If you are deploying onto Heroku, then you will need to install a couple of dependencies before WKHTMLTOPDF will work.
+
+Add the Heroku buildpack `https://buildpack-registry.s3.amazonaws.com/buildpacks/heroku-community/apt.tgz`
+
+Then create an `Aptfile` in your root directory with the dependencies:
+
+.. code::shell
+  libjpeg62
+  libc6

README.rst

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3.6
+#!/usr/bin/env python3.8
 """
 pydf
 
@@ -55,7 +55,7 @@ async def generate(request):
 app = web.Application()
 app.router.add_get('/', index)
 app.router.add_route('*', '/generate.pdf', generate)
-app['apydf'] = AsyncPydf(loop=app.loop)
+app['apydf'] = AsyncPydf()
 
 port = int(os.getenv('PORT', '80'))
 logger.info('starting pydf server on port %s', port)

docker-entrypoint.py

@@ -1,3 +1 @@
-from distutils.version import StrictVersion
-
-VERSION = StrictVersion('0.38.0')
+VERSION = '0.39.0'

pydf/bin/wkhtmltopdf

@@ -62,34 +62,39 @@ async def generate_pdf(self, html, **cmd_args):
                 stdin=asyncio.subprocess.PIPE,
                 stdout=asyncio.subprocess.PIPE,
                 stderr=asyncio.subprocess.PIPE,
-                loop=self.loop
+                loop=self.loop,
             )
             p.stdin.write(html.encode())
             p.stdin.close()
             await p.wait()
             pdf_content = await p.stdout.read()
             if p.returncode != 0 and pdf_content[:4] != b'%PDF':
                 stderr = await p.stderr.read()
-                raise RuntimeError('error running wkhtmltopdf, command: {!r}\n'
-                                   'response: "{}"'.format(cmd_args, stderr.decode().strip()))
+                raise RuntimeError(
+                    'error running wkhtmltopdf, command: {!r}\n'
+                    'response: "{}"'.format(cmd_args, stderr.decode().strip())
+                )
             return pdf_content
 
 
-def generate_pdf(html, *,
-                 cache_dir: Path=DFT_CACHE_DIR,
-                 grayscale: bool=False,
-                 lowquality: bool=False,
-                 margin_bottom: str=None,
-                 margin_left: str=None,
-                 margin_right: str=None,
-                 margin_top: str=None,
-                 orientation: str=None,
-                 page_height: str=None,
-                 page_width: str=None,
-                 page_size: str=None,
-                 image_dpi: str=None,
-                 image_quality: str=None,
-                 **extra_kwargs):
+def generate_pdf(
+    html,
+    *,
+    cache_dir: Path = DFT_CACHE_DIR,
+    grayscale: bool = False,
+    lowquality: bool = False,
+    margin_bottom: str = None,
+    margin_left: str = None,
+    margin_right: str = None,
+    margin_top: str = None,
+    orientation: str = None,
+    page_height: str = None,
+    page_width: str = None,
+    page_size: str = None,
+    image_dpi: str = None,
+    image_quality: str = None,
+    **extra_kwargs,
+):
     """
     Generate a pdf from either a url or a html string.
 
@@ -148,8 +153,9 @@ def generate_pdf(html, *,
     # it seems wkhtmltopdf's error codes can be false, we'll ignore them if we
     # seem to have generated a pdf
     if p.returncode != 0 and pdf_content[:4] != b'%PDF':
-        raise RuntimeError('error running wkhtmltopdf, command: {!r}\n'
-                           'response: "{}"'.format(cmd_args, p.stderr.decode().strip()))
+        raise RuntimeError(
+            'error running wkhtmltopdf, command: {!r}\n' 'response: "{}"'.format(cmd_args, p.stderr.decode().strip())
+        )
     return pdf_content
 
 

pydf/version.py

@@ -1,11 +1,12 @@
 [tool:pytest]
 testpaths = tests
-addopts = --isort
 timeout = 10
 
 [flake8]
-max-complexity = 10
 max-line-length = 120
+max-complexity = 12
+# required to work with black
+ignore = E203, W503, W504
 
 [bdist_wheel]
 python-tag = py36