Skip to main content

A simple Django application to process SSI includes

Project description

ssi-views

A simple Django application to process SSI includes

PyPI Build Status Software license

Compatibility

  • django >= 1.11
  • python >= 3.6

Features

  • Supported Function-Based and Class-Based Views
  • One URL pattern to rule them all for all SSI views
  • Jinja2 support

Installation

Install the package via Pip:

pip install ssi-views

Add it to your INSTALLED_APPS list:

INSTALLED_APPS = (
    ...
    'ssi_views',
)

Add ssi_views.urls to your URLconf:

urlpatterns = patterns('',
    ...

    # Django >= 2.0
    path('ssi/', include('ssi_views.urls')),

    # Django < 2.0
    url(r'^ssi/', include('ssi_views.urls', namespace='ssi_views')),
)

Usage

@ssi_view('name')

Use this decorator to register your views (Function-Based or Class-Based).

from ssi_views.decorators import ssi_view

@ssi_view('myapp.form')
def form_view(request):
    ...

@ssi_view('myapp.form_cbv')
class SSIFormView(FormView):
    ...

NOTE: The specified name has to be unique.

You can combine ssi_view with other decorators:

@csrf_exempt
@require_POST
@ssi_view('myapp.contact_form')
def csrf_exempt_view(request):
    # ...

{% ssi_include %}

Template tag to render <!--# include virtual="..." --> directive.

{% load ssi_views %}

{% ssi_include "myapp.form" %}

Output:

<!--# include virtual="/ssi/myapp.form/" -->

{% ssi_url %}

This tag is used to add SSI URLs in the template files:

{% load ssi_views %}

<!--# include virtual="{% ssi_url 'myapp.form' %}" -->

Multiple names

You can have multiple names for the same view:

from ssi_views.decorators import ssi_view

@ssi_view(['myapp.form', 'myapp.fallback'])
def example_view(request):
    ...

Jinja2 support

Enable Jinja2 extension

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.jinja2.Jinja2',
        'OPTIONS': {
            'extensions': [
                ...
                'ssi_views.templatetags.ssi_views.SSIIncludeExtension',
            ]
        }
    }
]

NOTE: If you are using django-jinja, you don't need to do this.

The usage is similar to Django, except that ssi_url is a global function:

<!--# include virtual="{{ ssi_url('myapp.form') }}" -->

Development and Testing

After cloning the Git repository, you should install this in a virtualenv and set up for development:

virtualenv .venv
source .venv/bin/activate
pip install -r ./requirements.txt
pre-commit install

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

ssi-views-0.4.1.tar.gz (8.7 kB view hashes)

Uploaded Source

Built Distribution

ssi_views-0.4.1-py2.py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 2 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