Django models extension that allows render model from instance

Installation

Install package from pip

$ pip install django-model-render

OR from source

python setup.py install

Configuration

Add app to settings.INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'model_render',
    ...
)

Settings

If you use jinja or other custom template engine you can use MODEL_RENDER_DEFAULT_EXTENSION to configute default template extension.

MODEL_RENDER_DEFAULT_EXTENSION = "jinja2"

default value is html

Add mixin to your models

from django.db import models
...
from model_render import ModelRenderMixin

class MyModel(ModelRenderMixin, models.Model):
    # ... fields here

Usage

Basic usage

Add model template in template folders and see how use it in templates:

    {{ mymodelInstance.render }}

Template

Model instance passsing in template context in variable named model

Search strategy

By default

render() method search template in <app_label>/models/<model_name>.<settings.MODEL_RENDER_DEFAULT_EXTENSION>

You can extend this two ways

Use Model.template_path attr.

Something like

class MyModel(ModelRenderMixin, models.Model):
    template_name="myapp/custom-template.html"
    # ... fields here

And all calls render() method will search in "myapp/custom-template.html".

Call render() method argument with argument

Something like

    {{ mymodelInstance.render("myapp/very-custom-template.html") }}

Only this call for render() method will search in "myapp/very-custom-template.html".

render(template=..., additional={'myvar': 123}) adds myvar to template context.