Readme
Nine CMS is a Django app to manage content. Users can create content and publish it to paths.
.. image:: https://img.shields.io/travis/Wtower/django-ninecms/devel.svg :target: https://travis-ci.org/Wtower/django-ninecms
.. image:: https://img.shields.io/coveralls/Wtower/django-ninecms/devel.svg :target: https://coveralls.io/github/Wtower/django-ninecms
.. image:: https://img.shields.io/pypi/v/django-ninecms.svg :target: https://pypi.python.org/pypi/django-ninecms :alt: Latest PyPI version
.. image:: https://img.shields.io/pypi/dm/django-ninecms.svg :target: https://pypi.python.org/pypi/django-ninecms :alt: Number of PyPI downloads per month
Admin screenshot:
.. image:: https://raw.githubusercontent.com/Wtower/django-ninecms/master/docs/screenshots/index1.png
Detailed documentation soon to be published.
It is the author's opinion that heavyweight content management systems are not so important to Django, as much as established CMS are important to other languages such as PHP. Django can be very easily used to build exotic web applications in very short time, therefore too often Django does not need another heavyweight CMS. Nine CMS is intended to provide a common denominator for simple content when building a Django app or for small sites.
To sum up:
Node modeling inspired by Drupal nodes featuring:
Content blocks
Menus
Media management
Views (requires decoupled signals providing context)
Taxonomy (terms)
Contact form
Admin interface with dashboard
Utilities
Bootstrap
The following are needed:
The following packages are optional/recommended:
Django 1.9 notices:
RemovedInDjango110Warning: render() must be called with a dict, not a Context. to a couple of places.
Many other apps get similar warnings. Looking for solution without offending Django <1.9.This is a full guide to create a new project. Soon a Quick Guide will be added.
There is also a project that can be used as an
Django 9cms web site boilerplate <http://www.github.com/Wtower/django-ninecms-starter>_.
Create a new project
Create a new project, if not existing, and optionally (as a reminder):
Dependencies
Add the following to the requirements.txt file::
Django~=1.9.0 django-ninecms>=0.5.4
And optionally::
coverage~=4.0.3 django-admin-bootstrapped~=2.5.6 django-admin-bootstrapped-plus>=0.1.1 django-bootstrap3~=7.0.1 django-debug-toolbar~=1.4.0 mysqlclient~=1.3.7 newrelic~=2.60.0.46 python3-memcached~=1.51 sqlparse~=0.1.18
Then run::
$ pip install -r requirements.txt
Download CKEditor (optionally) for rich text fields in admin:
static/ninecms/ckeditor so that ckeditor.js is in this directorybuild-config.js file is bundled in the above directorySettings
All relevant settings sample also exist in ninecms/settings.py as comment. From the code samples below remove any settings refer to optional packages that are not installed as above.
INSTALLED_APPS setting::
INSTALLED_APPS = ( 'admin_bootstrapped_plus', 'django_admin_bootstrapped', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'mptt', 'debug_toolbar', 'guardian', 'ninecms', # ... )
Middleware::
MIDDLEWARE_CLASSES = ( 'django.middleware.cache.UpdateCacheMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.locale.LocaleMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.cache.FetchFromCacheMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', 'django.middleware.security.SecurityMiddleware', )
Templates
Add 'debug': True only if planning to have a separate live settings file for your project::
TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [ os.path.join(BASE_DIR, 'templates'), ], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], 'debug': True, }, }, ]
Languages::
LANGUAGE_CODE = 'en' # or whatever LANGUAGES = ( ('en', 'English'), # ('el', 'Greek'), # ... ) TIME_ZONE = 'Europe/Athens' # or whatever USE_I18N = True USE_L10N = True USE_TZ = True
Static and Media::
STATICFILES_DIRS = ( os.path.join(BASE_DIR, "static"), ) MEDIA_ROOT = os.path.join(BASE_DIR, 'media') MEDIA_URL = '/media/'
Error reporting::
ADMINS = ( ("Webmaster", "web@9-dev.com"), ) MANAGERS = ( ("Webmaster", "web@9-dev.com"), ) EMAIL_HOST = 'mail.9-dev.com' EMAIL_HOST_USER = 'do-not-reply@9-dev.com' EMAIL_HOST_PASSWORD = '' EMAIL_USE_SSL = True EMAIL_PORT = 465 EMAIL_SUBJECT_PREFIX = '[9cms] ' SERVER_EMAIL = 'do-not-reply@9-dev.com' DEFAULT_FROM_EMAIL = 'do-not-reply@9-dev.com'
Security:
Replace myapp::
LOGIN_URL = '/admin/login/' SECURE_CONTENT_TYPE_NOSNIFF = True SECURE_BROWSER_XSS_FILTER = True X_FRAME_OPTIONS = 'DENY' CSRF_COOKIE_HTTPONLY = True SESSION_COOKIE_NAME = 'myapp_sessionid'
Caches::
CACHES = { 'default': { 'BACKEND': 'django.core.cache.backends.dummy.DummyCache', } } CACHE_MIDDLEWARE_SECONDS = 3 * 60 * 60 # or whatever
Guardian::
AUTHENTICATION_BACKENDS = ( 'django.contrib.auth.backends.ModelBackend', # this is default 'guardian.backends.ObjectPermissionBackend', ) ANONYMOUS_USER_ID = -1
Django admin::
DAB_FIELD_RENDERER = 'django_admin_bootstrapped.renderers.BootstrapFieldRenderer'
from django.contrib import messages MESSAGE_TAGS = { messages.SUCCESS: 'alert-success success', messages.WARNING: 'alert-warning warning', messages.ERROR: 'alert-danger error' }
CMS settings::
from ninecms.settings import * SITE_NAME = "..." SITE_AUTHOR = "..." SITE_KEYWORDS = "..." I18N_URLS = True # False
Optional settings for testing (separate file eg settings_test.py)::
from myapp.settings import * DEBUG = True PASSWORD_HASHERS = ( 'django.contrib.auth.hashers.MD5PasswordHasher', ) TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [ # disable overriden templates ], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], 'debug': True, }, }, ] DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), } } LANGUAGES = ( # at least 2 ('el', 'Greek'), ('en', 'English'), ) IMAGE_STYLES.update({ 'thumbnail-upscale': { 'type': 'thumbnail-upscale', 'size': (150, 150) }, })
Optional settings for live (separate file eg settings_live.py)::
from myapp.settings import * DEBUG = False ALLOWED_HOSTS = [ # ... ] TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [ os.path.join(BASE_DIR, 'templates'), ], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ]
STATICFILES_DIRS = [] CACHES = { 'default': { 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', 'LOCATION': '127.0.0.1:11211', 'TIMEOUT': 3 * 60 * 60, # or whatever 'KEY_PREFIX': 'myapp_', 'VERSION': 1, } }
Create empty folders in project root:
/static/
/media/
/media/ninecms/basic/image if you intend to run ninecms tests (see below).Run ./manage.py migrate to create the models.
Url configuration
robots.txtURL Example::
from django.conf import settings from django.conf.urls import include, url from django.conf.urls.i18n import i18n_patterns from django.conf.urls.static import static from django.contrib import admin from django.views.generic import TemplateView
urlpatterns = [ url(r'^admin/', include(admin.site.urls)), url(r'^i18n/', include('django.conf.urls.i18n')), url(r'^robots.txt/$', TemplateView.as_view(template_name='ninecms/robots.txt', content_type='text/plain')), ]
if settings.DEBUG: urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) # pragma: no cover
if settings.I18N_URLS: # pragma: nocover urlpatterns += i18n_patterns( url(r'^', include('ninecms.urls', namespace='ninecms')), ) else: # pragma: nocover urlpatterns += [ url(r'^', include('ninecms.urls', namespace='ninecms')), ]
Start the development server and visit http://127.0.0.1:8000/admin/
You'll need the Admin app enabled and a superuser with python manage.py createsuperuser.
Visit http://127.0.0.1:8000/ to view content.
Optionally run test with python manage.py test --settings=myapp.settings_test ninecms.
From here on common tasks include:
Theming is easy and straightforward. Besides from developing a custom theme, it is easy to use any ready-made HTML theme from the myriads available on the web.
(Changes in v0.6.0)
There is a base.html which gets extended by an index.html. The base declares the doc type (HTML5),
loads scripts, all defined in blocks.
The index file is the one that most probably needs to be overridden. You can check the base to see where each of the following blocks appears. These are defined by order of appearance:
meta: define any custom keywords in <head>.
Some defaults are generated based on settings and the node (page) presented.head: define any additional elements at the bottom of the <head>.
Here add favicon and additional stylesheets / head scripts.body_attrs: define any additional attributes to be appended to <body>.
Default is class only.body_top: a small link to the top of the page. This is used by a small javascript to display by default
a small fixed top link at the right bottom of the page, after having scrolled down. If it is not overridden,
then you might need to add a static/ninecms/images/toplink.png background or custom css for #toplink.body_loader: a convenient page loader (splash screen) is defined.
Override and leave blank if not suitable.content: this is the main content block that needs to be overridden in index.body_bottom: a small non-visible link at the bottom of the page.body_scripts: define any additional content at the bottom of the <body>.
Here add additional scripts to be loaded in the end of the document.The index file is the default template that is used, but it can be extended to be used in page types (see theme suggestions below).
The templates in the ninecms/templates folder are examples of how to render specific contexts of blocks
and can be used either with {% include %} or can be copied into the custom templates directly.
Each page type can have its own template. Ninecms chooses template for the page type based in the template filename, in the following order:
page_[page_type.name][page_type.name]index.htmlwhere [page_type.name] is the machine name of the page type,
eg. if the page type name is 'Basic Page' then this will be basic_page.
It is good to extend the template from index and use Django blocks at will.
Page types are central to the organisation of a CMS content. In NineCMS, apart from logically organising content to relevant page types, which can be done also with taxonomy terms, each page type can have a different page layout, with different blocks.
Page types do not feature custom fields and thus cannot be used as the separation of entity-like models, as eg. in Drupal. There is no intention to add such a feature as Django models can be very easily be added in code and extend the CMS functionality.
Each content type can have a pre-specified default url alias for the nodes under it. If a node of that page type does not have a url alias specified, the default will be used.
The following replacement tokens can be used:
[node:id]: The id of the node.[node:title]: The transliterated slugified title of the node.[node:created:format]: The date of node creation.[node:changed:format]: The date of last node update.PHP date format_ specifier in form
(specifier)(separator)(specifier)(separator)(specifier), eg d-m-Y... _PHP date format: http://www.php.net/date
The following block types are supported:
static: Static content provided by linking to a node.
Unlike from Drupal concept of block that defines a text fields anyway.menu: Render a menu or submenu by linking to a menu item.signal: Call a site-specific custom view render (see Views below).language: Render a language switch menu.user-menu: Render a user menu with login/logout or register links.login: Render a login form.search: Render a search form.search-results: Render search results. Simple search functionality. For advanced search a proper package
needs to be used. For a search results page add a new page type and implement the block. Case insensitive
search cannot be done in Sqlite (see also Important points below).contact: Render a contact form.Add a new Django app in your project with signals.py to listen to the corresponding signal that is declared with
a new content block in admin.
Look at the ninecms/signals.py file on how to code the signals.
This is a summary of all applicable permissions:
Django admin:
User: is staff (access to admin)
User: is superuser (with caution)
User: add, change, delete
Group: add, change, delete
Permission: add, change, delete
Guardian:
9cms:
Example of configuration of an editor group perms:
(Changes in v0.6.0)
Front-end package management is an important aspect of any site. In NineCMS, Libraries had been a minor convenience feature to integrate front-end packages. It has been removed because there are already several existing possibilities than can be easily used.
An extension to NineCMS will soon be available for this matter. Alternatively, django-bower is good.
NineCMS allows to display images using specific styles. Some predefined styles can be found in ninecms/settings.py.
These can be extended or replaced using the IMAGE_STYLES in the project's settings.py.
This is a dictionary where the index is the defined style name and its value is a dictionary with indexes type
and value. For example::
IMAGE_STYLES.update({'my_style': {'type': 'thumbnail', 'size': (120, 100)}})
Possible types can be:
thumbnail: Scales an image to the smallest provided dimension.thumbnail-upscale: Scales an image to the provided dimensions, allowing upscale.thumbnail-crop: Crops an image to the ratio of the provided dimensions and the scales it.The in order to use an image style in a template (eg for a node context::
<img src="{{ node.image_set.all.0.image.url|image_style:'my_style' }}">
NineCMS uses the Imagemagick<http://www.imagemagick.org/script/binary-releases.php>_ library for this matter.
In order to use image styles it has to be installed on the server. When an image style for a particular image
is requested for the first time, NineCMS uses Imagemagick to create a new file in a new directory in the
initial file path with the name of the style. To refresh this file cache simply remove the directory with
the style name. Be careful not to remove the original file.
Pillow has not been used becaue at that time it had multiple issues with Python3. If a large memcache or redis is
available, sorl-thumbnail<https://github.com/mariocesar/sorl-thumbnail>_ may be a better solution
for high traffic web sites.
Any contribution to the project is highly appreciated and the best will be done to respond to it.
FAQs
Nine CMS is a Django app to manage content.
We found that django-ninecms demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.