Skip to main content

Rendertron middleware for python applications

Project description

Python Rendertron

Rendertron middleware for Python applications.

Rendertron is a headless Chrome rendering solution designed to render & serialise web pages on the fly. The goal of this package is to provide middleware to render a request using a Rendertron service and make the result available.

This makes it possible to for example render Progressive Web Apps (PWA), wait for it to fully render (completes initial data loading etc.) and use that fully built markup as a response.

Besides the fact that your user will see a fully rendered application faster it also allows search engines to properly index the markup.

Installing

Install a Rendertron service by following the steps in the documentation.

The goal is to publish this package to PyPI once it is stable. Until then install it using pip's -e flag:

pip install -e git://git@github.com:frontendr/python-rendertron.git@develop#egg=rendertron

This will install the develop branch.

Django

  1. Add 'rendertron' to the INSTALLED_APPS list in settings.
  2. Add 'rendertron.middleware.DjangoRendertronMiddleware' to the MIDDLEWARE list in the settings.

Configuration

Most configuration is done by specifying specific variables. For Django users that's done in your site's settings.

The following settings are available:

  • RENDERTRON_URL - Default: 'http://localhost:3000/'. The url the Rendertron service is listening on.
  • RENDERTRON_RENDER_QUERY_PARAM - Default: 'rendertron_render'. The query parameter added to the request url passed to Rendertron. This is used to differentiate normal requests with requests from Rendertron.
  • RENDERTRON_STORAGE - An object literal specifying and configuring the storage class to be used. See the Storage section for more information.
  • RENDERTRON_INCLUDE_PATTERNS - Default: [] (empty list). A list of reqular expression patterns to include. Once a pattern in this list matches the request no further checking will be done.
  • RENDERTRON_EXCLUDE_PATTERNS - By default this is a list of common static file type extensions used on the web. If Django is detected it's STATIC_URL and MEDIA_URL paths are added to the list. Note that if you override this setting all defaults are gone. If you want to keep these defaults and add your own patterns use RENDERTRON_EXCLUDE_PATTERNS_EXTRA.
  • RENDERTRON_EXCLUDE_PATTERNS_EXTRA - Default: [] (empty list). Like RENDERTRON_EXCLUDE_PATTERNS but will be appended to that list.

Storage

Storage classes are handling the logic of storing the results coming from the Rendertron service for a period of time. They handle if, how, where and how long a result is stored. There are some core storage classes available the system is built for it to be very easy to built your own.

The choice of one of the built in storage classes depends on your framework.

Any framework: DummyStorage

A storage class that doesn't do anything. It doesn't store and will never return a stored result.

To use it simply set RENDERTRON_STORAGE['CLASS'] to 'rendertron.storage.DummyStorage'. It has no options.

Django: DjangoCacheStorage

A storage class that utilizes Django's cache framework to store the results.

To use it simply set RENDERTRON_STORAGE['CLASS'] to 'rendertron.storage.DjangoCacheStorage'. It has the following options:

  • TIMEOUT: The number of seconds the result should be stored in the cache. It's the timeout argument for Django's cache.set method and also defaults to Django's DEFAULT_TIMEOUT which is 300 (5 minutes).
  • VERSION: The version argument which is passed to Django's cache.set method.
RENDERTRON_STORAGE = {
    'CLASS': 'rendertron.storage.DjangoCacheStorage',
    'OPTIONS': {
        'TIMEOUT': 300,
    }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rendertron-0.0.1.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

rendertron-0.0.1-py3-none-any.whl (10.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page