django-flatly 0.2.0

Serving flat pages with Django without views and database.

django-flatly

Serving flat pages with Django without views and database.

Helps to separate deployment of front- and backend.

Installation

Install the latest release with pip:

pip install django-flatly

Than add a URL to urlpatterns:

# urls.py
urlpatterns = [
    ...,
    # all others urls above - flatly.urls last one to try!
    path('', include('flatly.urls')),
]

Quick start

1. In your root template directory create flatly folder.

2. Define FLATLY_TEMPLATE_ROOT setting:

   FLATLY_TEMPLATE_ROOT = 'flatly'
   

3. Any .html files you create in your flatly directory will be automatically served. So if you create a new file flatly/about_us/overview.html then it will be visible at /about-us/overview/.

Note that django-flatly automatically replaces underscores (_) with dashes (-).

Search path

Suppose you are requesting the page /account/user-profile/, django-flatly will render the first template that exists:

1. ${FLATLY_TEMPLATE_ROOT}/account/user_profile
2. ${FLATLY_TEMPLATE_ROOT}/account/user_profile.html
3. ${FLATLY_TEMPLATE_ROOT}/account/user_profile/index.html

Settings

Template root

django-flatly based on Django's get_template function. So, any user can access any template on your website. You can restrict access to certain templates by adding the following:

FLATLY_TEMPLATE_ROOT = 'flatly'

By adding the above configuration django-flatly will add specified path prefix to the template name before search.

Note that flatly folder can be located in both root and application template directories.

Defaults to flatly.

Template engine

You can restrict the template search to a particular template engine.

FLATLY_ENGINE = 'jinja2'

Defaults to None.

Template caching

By default (when DEBUG is True), the template system searches, reads and compiles your templates every time they’re rendered. It's convenient for local development, because no need to restart the server after adding/removing templates.

You can enforce template caching:

FLATLY_CACHE_ENABLED = True

The cached Template instance is returned for subsequent requests to load the same template.

Defaults to True is settings.DEBUG is False.

Extensions

List of file extensions to iterate over all matching files.

FLATLY_EXTENSIONS = ['html', 'jinja2']

Defaults to ['html'].

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_dev.txt
pre-commit install