Django CMS for presentation websites
Project description
Django Xprez
Xprez is CMS For Django
Quick start
- Install django-xprez:
pip install django-xprez
- Add following apps to your settings.INSTALLED_APPS:
INSTALLED_APPS = [
...
'django.contrib.humanize',
'sorl.thumbnail',
'xprez',
'xprez.ck_editor',
...
]
-
Run
python manage.py migrate
to create xprez models. -
Make sure request context processor is enabled in settings:
TEMPLATES = [
...
'OPTIONS': {
'context_processors': [
...
'django.template.context_processors.request',
...
]
},
...
]
- Include the xprez admin URLconf in your project urls.py like this:
path('xprez/', include('xprez.urls')),
- Create models:
from xprez.models import ContentsContainer
class Page(ContentsContainer):
title = models.CharField(max_length=255)
slug = models.SlugField(max_length=255, unique=True)
def __str__(self):
return self.title
- Register models in admin:
from django.contrib import admin
from xprez.admin import XprezAdmin
from .models import Page
@admin.register(Page)
class PageAdmin(XprezAdmin):
pass
- Render page in template:
{% load xprez %}
{% xprez_front_media %}
{% include 'xprez/container.html' with contents=page.contents.all %}
- (optional) Change sorl thumbnail backend in settings - for seo-friendly thumbnail filenames:
THUMBNAIL_BACKEND = 'xprez.contrib.sorl_thumbnail.thumbnail_backend.NamingThumbnailBackend'
Development
To setup automated black formatting connected to git commits:
- install pre-commit
- run
pre-commit install
To rebuild ckeditor:
cd xprez/ck_editor/assets/ckeditor5
npm install
npm run build
To rebuild css styles
cd xprez/static/xprez
npm install
npm run build (or `watch` for developing)
Deploying new version
Tagging new version
Update setup.py -> VERSION
On localhost run:
git tag vX.Y.Z
git push origin vX.Y.Z
Draft release on github
Go to: https://github.com/s-cape/django_xprez/releases
-> Draft new release
Select tag vX.Y.Z
and name vX.Y.Z
requirements
python -m pip install --user --upgrade setuptools wheel twine
cleanup old builds (if exists)
rm -rf ./dist ./build
create dist package
python setup.py sdist bdist_wheel
to check package add this to requirements.txt
file:/<path_to_package>/dist/django_xprez-<version>.tar.gz
upload to testpypi
python -m twine upload --repository testpypi dist/*
to check package from testpypi add (temporary) this to top of requirements.txt:
--extra-index-url https://test.pypi.org/simple/
upload to pypi
python -m twine upload dist/*
TODO
- fix template content to save only relative path to database
- check template content raising UnicodeDecodeError
- create manual for various situations (ck_editor branch)
- using custom config and implement style sources into own building system (using get_module_path.py)
- how to implement
xprezanchor
functionality
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django_xprez-0.2.0.tar.gz
(6.3 MB
view hashes)
Built Distribution
Close
Hashes for django_xprez-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a9d17454c8e1a4385f02450dcb147ef3f59b491440459d682036f86676f736a |
|
MD5 | 0b0e77e03ff8d962456d81e0d2c4ad63 |
|
BLAKE2b-256 | 72e0efad5c49dcd3db4b918164596f38b2b61a562fecacdcffbe8fbcfb540feb |