mtik00/wkhtmltopdf-service repository overview

⁠wkhtmltopdf-service

Yet another web app providing an interface to the awesome wkhtmltopdf binary.

This project is meant for my own projects that rely on wkhtmltopdf. I'm trying to dockerize my apps, and this will be very handy for doing that!

The hardest part about this is getting the fonts correct.

If you can't use this image directly, hopefully the existing Dockerfile⁠ can guide you most of the way.

⁠Requirements

This project is meant to be ran in a docker container. However, nothing is stopping you from running it locally.

• You must have wkhtmltopdf in your path
• Your Python environment must have:
  • starlette
  • aiofiles
• You must have some kind of asgi server (I'm using uvicorn)
• Copy src/app.py⁠ to your environment

Your environment will need to have certain fonts installed if you want a one-to-one conversion of the HTML. The docker image provided only includes the fonts that I'm using in other projects. See the wkhtmltopdf documentation for font usage.

If you're OK with how the docker image is set up, you can just run the container:

docker run --rm -p 8080:8080 mtik00/wkhtmltopdf-service:latest

and be done with it.

⁠Usage

There are two endpoints for converting HTML to PDF: uri and data. Both of these endpoints only respond to POST methods.

The following examples assume you are running the service on localhost port 8080.

⁠url

uri is meant to convert another endpoint that can be reached by the running service.

The URI to convert must be passed in the body using json. For example:

curl -v -X POST -d '{"uri": "http://google.com"}' --output test.pdf http://localhost:8080/uri

⁠data

data is meant to convert the body of a request. The body must be valid HTML. For example:

curl -v -x POST -d '<h1>Hello, World!</h1><br><tt>This is a test</tt>' --output test.pdf http://localhost:8080/data

This is handy when you are generating the HTML you wish to convert.

⁠Releasing

1. Use poetry to bump a version. For example:

   poetry version minor
   

   Copy
2. Modify CHANGELOG.md accordingly
3. Add the changed files

   git add pyproject.toml CHANGELOG.md && \
   git ci -m"bumping version"
   

   Copy
4. Create the tag

   git tag v$(poetry version -s)
   

   Copy
5. Push the new code/tags:

   git push && git push --tags
   

   Copy
6. Push the new image:

   make VERSION=$(poetry version -s) push
   

   Copy