Skip to main content

HTML content blocks for Django.

Project description

PyPI Package Version MIT License PyPI Status

Python Versions Supported Django Versions Supported

Test Coverage Read the Docs

Code Style Black PyPI Downloads GitHub Repo Stars

Django Content Blocks

Django Content Blocks is a reusable Django app that allows users to create and manage custom content blocks for their website. It aims to provide content management and page building features from within the admin site without being a full CMS app or reinventing the admin site.

The content block editor is a simple page builder that integrates seamlessly into the admin site, it provides an easy-to-use interface for creating content blocks.

The content block editor in the Django admin site.

The content block editor in the Django admin site.

Content blocks can be related to any other object. This allows you to provide rich, dynamic, editable content for your existing models such as pages, products, projects or whatever models you have.

The templates used to render content blocks are made in the same way as any other template in your project, giving you access to the full power of your chosen template engine. You define the fields that are available to edit your content blocks in the content block editor. This means you can build a content block template once and reuse it over and over again.

Content blocks can contain any type of content, including text, images, videos, and more, and can be arranged in any order. Additionally, Django Content Blocks includes support for drafts and previews, allowing users to see how their changes will look before publishing them.

Installation instructions and detailed documentation can be found on ReadTheDocs.

Development Status & Roadmap

Django content blocks is already in use in a number of production websites however it is still considered to be in beta as active development continues.

Major development plans/ideas include:

  • Content block editor HTML, CSS and JS rework.
    • This all needs updating to use modern HTML and CSS (flex, grid etc) and vanilla JS.

    • Currently using jQuery which isn’t the end of the world as it comes with django.contrib.admin so not an extra dependency.

  • Option for vertical layout for nested forms in the content block editor
    • Sometimes nested blocks can represent columns within a content block. It would be nice to give the option to have these shown side by side in the content block editor.

  • django-content-blocks 2.0
    • This will be a major rewrite which will move the representation of content blocks out of the database and into a JSONField. This will greatly improve performance as the whole representation of an object’s content blocks can be returned at once and any subsequent queries required can be made in a prefetch fashion.

    • The ContentBlockField will become pluggable allowing developers to add/remove available fields from within their project.

  • Django content blocks suite of apps providing additional functionality and basic apps powered by content blocks:
    • CMS

    • Blog

    • Contact forms

Dependencies (and Thank You)

Thank You

Contributing

Contributions, advice and guidance are welcome. Please make contact before writing any code!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-content-blocks-1.5.2.tar.gz (492.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_content_blocks-1.5.2-py3-none-any.whl (511.9 kB view details)

Uploaded Python 3

File details

Details for the file django-content-blocks-1.5.2.tar.gz.

File metadata

  • Download URL: django-content-blocks-1.5.2.tar.gz
  • Upload date:
  • Size: 492.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for django-content-blocks-1.5.2.tar.gz
Algorithm Hash digest
SHA256 80ae70e913ac71f59d1ead9b406a56147c37edd908df18905b7164cbcb51314c
MD5 01c28ace5d18c6a4b434bdf5293502c1
BLAKE2b-256 c1b0bc786def5c41029d32b6ac753f455644d21fd6a7bfe713d9f7bc4aa424c5

See more details on using hashes here.

File details

Details for the file django_content_blocks-1.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_content_blocks-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7fd2c13c2a39d94fa72f62a3cd474029558dc7bc7b7d8052d4fd77e7fd68d17d
MD5 13a3dae4518cfd57e9b4dbe3c1d50812
BLAKE2b-256 ea1e354372aef718bf18d7669b0ea2726edfa86c0ccb564737f31ead3a0b4a7d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page