Splash is a javascript rendering service with a HTTP API. It runs on top of twisted and QT webkit for rendering pages.
The (twisted) QT reactor is used to make the sever fully asynchronous allowing to take advantage of webkit concurrency via QT main loop.
See requirements.txt
To run the server:
python -m splash.serverThe following endpoints are supported:
Return the HTML of the javascript-rendered page.
Arguments:
- url : string : required
The url to render (required)
- baseurl : string : optional
The base url to render the page with.
If given, base HTML content will be feched from the URL given in the url argument, and render using this as the base url.
- timeout : float : optional
A timeout (in seconds) for the render (defaults to 30)
Curl example:
curl http://localhost:8050/render.html?url=http://domain.com/page-with-javascript.html&timeout=10Return a image (in PNG format) of the javascript-rendered page.
Arguments:
Same as render.html plus the following ones:
- width : integer : optional
Resize the rendered image to the given width (in pixels) keeping the aspect ratio.
- height : integer : optional
Crop the renderd image to the given height (in pixels). Often used in conjunction with the width argument to generate fixed-size thumbnails.
- vwidth : integer : optional
View width. Size (in pixels) of the browser viewport to render the web page. Defaults to 1024.
- vheight : integer : optional
View height. Size (in pixels) of the browser viewport to render the web page. Defaults to 768.
Curl examples:
# render with timeout
curl http://localhost:8050/render.png?url=http://domain.com/page-with-javascript.html&timeout=10
# 320x240 thumbnail
curl http://localhost:8050/render.png?url=http://domain.com/page-with-javascript.html&width=320&height=240Run with:
nosetestsThere are some stress tests that spawn its own splash server and a mock server to run tests against.
To run the stress tests:
python -m splash.tests.stressTypical output:
$ python -m splash.tests.stress
Total requests: 1000
Concurrency : 50
Log file : /tmp/splash-stress-48H91h.log
........................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
Received/Expected (per status code or error):
200: 500/500
504: 200/200
502: 300/300