Repository files navigation

Rendertron middleware for Python applications.

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

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

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

Install a Rendertron service by following the steps inthe documentation.

Install this package usingpip:

pip install rendertron

You can also install the latest development version usingpip's-e flag:

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

This will install thedevelop branch.

First, add'rendertron' to theINSTALLED_APPS list in settings.

Then you have 2 choices:

• Enable themiddleware and render everything that matches eitherRENDERTRON_INCLUDE_PATTERNS or does not matches anything inRENDERTRON_EXCLUDE_PATTERNS. See the Configuration section for more information aboutthose.
• Decorate specific views with the@rendertron_render decorator to only let renderthose views with the Rendertron service.

1. Add'rendertron.middleware.DjangoRendertronMiddleware' to theMIDDLEWARElist in the settings.
2. Make sure to specify eitherRENDERTRON_INCLUDE_PATTERNS to specify path patternswhich are to be rendered by the Rendertron service orRENDERTRON_EXCLUDE_PATTERNS_EXTRAto only specify what to exclude.

Instead of relying on the middleware and settings it is also possible to decoratespecific views with the@rendertron_render decorator.

fromrendertron.decorators.djangoimportrendertron_render@rendertron_renderdefmy_view(request):    ...

For class based views use Django'smethod_decorator.

fromdjango.utils.decoratorsimportmethod_decoratorfromdjango.views.genericimportTemplateViewfromrendertron.decorators.djangoimportrendertron_render@method_decorator(rendertron_render,name="dispatch")classMyView(TemplateView):    ...

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

The following settings are available:

Storage classes are handling the logic of storing the results coming from theRendertron service for a period of time. They handle if, how, where and howlong a result is stored. There are some core storage classes available thesystem 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.

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

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

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

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

Example config:

RENDERTRON_STORAGE= {'CLASS':'rendertron.storage.DjangoCacheStorage','OPTIONS': {'TIMEOUT':300,    }}

First install Django to be able to test Django related things.

pip install django

Then run the tests viadjango-admin using the provided minimal settings file.

django-admintest --pythonpath. --settings tests.django.settings

MIT