Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dldevinc/django-flatly
Serving flat pages with Django without applications and views
https://github.com/dldevinc/django-flatly
django flatpages templates
Last synced: about 1 month ago
JSON representation
Serving flat pages with Django without applications and views
- Host: GitHub
- URL: https://github.com/dldevinc/django-flatly
- Owner: dldevinc
- License: bsd-3-clause
- Created: 2020-07-09T22:22:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T09:51:49.000Z (over 1 year ago)
- Last Synced: 2024-11-16T18:47:26.337Z (2 months ago)
- Topics: django, flatpages, templates
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# django-flatly
Serving flat pages with Django without views and database.
Helps to separate deployment of front- and backend.
[](https://pypi.org/project/django-flatly/)
[](https://github.com/dldevinc/django-flatly)
[](https://pypi.org/project/django-flatly/)
## Compatibility
- `django` >= 2.0
- `python` >= 3.6
## Installation
Install the latest release with pip:
`pip install django-flatly`
Than add a URL to urlpatterns:
```python
# 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:
```python
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, user can access any template on your website. You can
restrict access to certain templates by adding the path prefix
to the template name before search:
```python
FLATLY_TEMPLATE_ROOT = 'flatly'
```
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.
```python
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:
```python
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.
```python
FLATLY_EXTENSIONS = ['html', 'jinja2']
```
Defaults to `['html']`.