https://github.com/ojii/django-statictemplate

This project aims at providing a compromise between dynamic error pages for Django (that use template tags etc and therefore potentially error too) and having to write static error pages by hand.
https://github.com/ojii/django-statictemplate

Last synced: 8 days ago
JSON representation

This project aims at providing a compromise between dynamic error pages for Django (that use template tags etc and therefore potentially error too) and having to write static error pages by hand.

• Host: GitHub
• URL: https://github.com/ojii/django-statictemplate
• Owner: ojii
• License: other
• Created: 2012-04-11T09:25:21.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-12-23T13:38:05.000Z (almost 6 years ago)
• Last Synced: 2024-10-08T09:33:59.163Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 41 KB
• Stars: 15
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
#####################

Django Statictemplate

#####################

.. image:: https://img.shields.io/pypi/v/django-statictemplate.svg?style=flat-square

    :target: https://pypi.python.org/pypi/django-statictemplate/

    :alt: Latest Version

.. image:: https://img.shields.io/travis/ojii/django-statictemplate.svg?style=flat-square

    :target: https://travis-ci.org/ojii/django-statictemplate

    :alt: Travis status

.. image:: https://img.shields.io/coveralls/ojii/django-statictemplate.svg?style=flat-square

    :target: https://coveralls.io/r/ojii/django-statictemplate

    :alt: Coveralls status

.. image:: https://img.shields.io/pypi/dm/django-statictemplate.svg?style=flat-square

    :target: https://pypi.python.org/pypi//django-statictemplate/

    :alt: Download

.. image:: https://img.shields.io/pypi/wheel/django-statictemplate.svg?style=flat-square

    :target: https://pypi.python.org/pypi/django-statictemplate/

    :alt: Wheel Status

.. image:: 	https://img.shields.io/pypi/l/django-statictemplate.svg?style=flat-square

    :target: https://pypi.python.org/pypi/django-statictemplate/

    :alt: License

This project aims at providing a compromise between dynamic error pages for

Django (that use template tags etc and therefore potentially error too) and

having to write static error pages by hand.

It does so by providing a management command that can be invoked to turn a

dynamic Django template into a static HTML page with no template tags

whatsoever in it.

Note that this means that every time you change your error pages, you need to

re-run this script. Ideally this is part of your deploy process.

**Supported Django versions: 1.8, 1.9, 1.10, 1.11**

For older versions use ``django-statictemplate==2.0.1``

************

Installation

************

``pip install django-statictemplate`` inside your virtualenv.

Add ``statictemplate`` to your ``INSTALLED_APPS``.

*************

Configuration

*************

``django-statictemplate`` does not require any configuration. by default.

By default ``django-statictemplate`` overrides the configured middlewares for

enhanced compatibility and to avoid incompatibilities.

However this may not be always feasible: if you need a specific set of

middlewares to be loaded set::

    STATICTEMPLATE_OVERRIDE_MIDDLEWARE = False

in you settings files.

Please note that ``django-statictemplate`` has not been tested with every

possible middleware, thus you may encounter failures and strange behaviors

especially fi you use middlewares that changes the response type.

*****

Usage

*****

``python manage.py statictemplate dynamic_500.html > 500.html``

or

``python manage.py statictemplate dynamic_500.html -f 500.html``

The management command renders a template given by name (standard Django

template name resolution applies) and writes the output to stdout or to a file.

=========

Arguments

=========

* ``template``: standard django template name to render

=======

Options

=======

* ``-f``, ``--file``: file destionation for command output

* ``-l``, ``--language-code``: sets the client django_language cookie to render

  page in the given language

* ``-f``, ``--file``: file destionation for command output

* ``-e``, ``--extra_request``: extra parameters injected in the request.

  Parameters must be serialized in querystring format (e.g.:

  ``'variable=value&variable=value'``; please note the single quote **'** to

  protect ampersand **&**).

*******

License

*******

This project is licensed under the BSD license.

************

Contributors

************

See https://github.com/ojii/django-statictemplate/contributors