An template based flatpage like app of Django.
Project description
An template based the flatpages like app. Not like django’s flatpages app, django-roughpages render a template file which determined from the accessed URL. It is quite combinient when you want to render simple static page. You do not need to prepare urls.py or views.py anymore for that kind of simple static page.
django-roughpages call roughpages.views.roughpage view with the accessed URL when django raise Http404 exception. The view automatically find the corresponding template file from roughpages directory in one of your template directories. Assume if the user accessed http://localhost/foo/bar/hoge/. If there is no urls pattern patched with the URL, django-roughpages try to find corresponding template file such as templates/roughpages/foo/bar/hoge.html. If django-roughpages find the corresponding template file, it will render the template and return the HttpResponse, otherwise it re-raise Http404 exception.
You can complicatedly select the corresponding template file. django-roughpages determine the filename with a backend system. The default backend is roughpages.backends.AuthTemplateFilenameBackend and it prefer hoge.anonymous.html or hoge.authenticated.html than hoge.html depends on the accessed user authentication state. Thus you can simply prepare the page for authenticated user as <something>.authenticated.html and for anonymous user as <something>.anonymous.html. Note that the filename which contains '.' is not allowed thus user cannot access hoge.authenticated.html with a url like /hoge.authenticated to prevent unwilling file acccess.
You can control the backend behavior with making a custom backend. To make a custom backend, you need to inherit roughpages.backends.TemplateFilenameBackendBase and override prepare_filenames(self, filename, request) method. The method receive an original filename and HttpRequest instance and must return a filename list. The django-roughpages then try to load template file from the beginning of the list, thus the order of the appearance is the matter.
Documentation
Installation
Use pip like:
$ pip install django-roughpages
Usage
Configuration
Add roughpages to the INSTALLED_APPS in your settings module
INSTALLED_APPS = ( # ... 'roughpages', )Add our extra fallback middleware
Django >= 1.10
MIDDLEWARE = ( # ... 'roughpages.middleware.RoughpageFallbackMiddleware', )Django < 1.10
MIDDLEWARE_CLASSES = ( # ... 'roughpages.middleware.RoughpageFallbackMiddleware', )Create roughpages directory in one of your template directories specified with settings.TEMPLATE_DIRS
Quick tutorial
Create roughpages/foo/bar/hoge.html as follow
<html> <body> This is Hoge </body> </html>Run syncdb and Start development server with python manage.py syncdb; python manage.py runserver 8000
Access http://localhost:8000/foo/bar/hoge/ and you will see “This is Hoge”
Create roughpages/foo/bar/piyo.anonymous.html as follow
<html> <body> This is Piyo Anonymous </body> </html>Create roughpages/foo/bar/piyo.authenticated.html as follow
<html> <body> This is Piyo Authenticated </body> </html>Access http://localhost:8000/foo/bar/piyo/ and you will see “This is Piyo Anonymous”
Access http://localhost:8000/admin/ and login as admin user.
Access http://localhost:8000/foo/bar/piyo/ and you will see “This is Piyo Authenticated”
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-roughpages-1.0.0.tar.gz.
File metadata
- Download URL: django-roughpages-1.0.0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 755d69bd600d70708fb2cf729ae2a9f5a42cb13d93d72b362ffe55fa2af5965f |
|
| MD5 | 1f6110cb937e41d4199275c4136a8d45 |
|
| BLAKE2b-256 | 7b54a4eec005276a52df32a811d2d002f89e60d5d01929af807ff6b73e0dfe7e |
