Skip to main content

Latest PyPI version Test coverage Python versions Django versions django CMS versions

django CMS stories application - Tell your story in multilingual posts, using the full power of django CMS placeholders.

djangocms-stories provides a lean foundation for storytelling that can be composed with other specialized django CMS applications, such as djangocms-versioning or djangocms-moderation.

Features

  • Frontend editing using django CMS frontend editor

  • Placeholder or optionally simpler TextField-based content editing

  • Multilingual support using django-parler

  • Multisite (posts can be visible in one or more Django sites on the same project)

  • Hooks into your page tree anywhere

  • Configurable permalinks, user navigation, template sets, …

  • Multiple instaces per site (e.g., blog, news, stories)

  • Django sitemap framework

  • django CMS Wizard integration

  • Supports djangocms-versioning and djangocms-moderation

Installation

To install the latest version directly from GitHub, run:

pip install djangocms-stories djangocms-text

Add djangocms_stories and djangocms_text to your INSTALLED_APPS in your Django project’s settings.py:

INSTALLED_APPS = [
    # ...
    'djangocms_text',  # required
    'djangocms_stories',
    'parler',  # if not already included
    'sortedm2m',  # if not already included

    # For now, but probably not needed in the future
    'taggit',
    'taggit_autosuggest',
    'meta',
    # ...
]

To use taggit’s autosuggest feature, add their URLS in urls.py:

urlpatterns += [path('taggit_autosuggest/', include('taggit_autosuggest.urls'))]

Migrating from djangocms-blog

Migrate from djangocms-blog by following the steps below. There is test coverage for the migration process - nevertheless be sure to backup your database before proceeding.

  1. Uninstall djangocsms-blog: pip uninstall djangocms-blog

  2. Install djangocms-stories pip install djangocms-stories

  3. Add "djangocms_stories" to your installed apps. Do not remove djangocms-blog.

  4. Run ./manage.py migrate djangocms_stories. This in migration 0002 will move existing content from djangocms-blog to djangocms-stories and delete djangocms-blogs database tables.

  5. Remove "djangocms_blog" from your installed apps.

  6. To be on the safe side, check that the app hooks in the advanced settings your blog pages have been updated.

Custom templates will need manual updating, since the underlying model structure has changed:

  • post contains the following fields: related, main_image, author, date, categories, tags

  • post_content contiains the following per-language fields: title, subtitle, slug, content, media, and post, the reference to the Post object.

Some improvements for developers are included:

  • You now can use the {% placeholder %} template tag in the post_detail.html template to render any placeholder. {% render_placeholder post_content.content %} and {% render_placeholder post_content.media %} are still available, but you can now use {% placeholder "new_content" %} to, say, add additional placeholders.

Contributing

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

The project makes use of git pre-commit hooks to maintain code quality. Please follow the installation steps to get pre-commit setup in your development environment.

We’re grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Credits

djangocms-stories is inspired by Nephila’s excellent djangocms-blog, with the intent to bring to align it with django CMS’s new philosophy since version 4: “The design philosophy of django CMS is to solve something complex with many simple things.”

Download files

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

Source Distribution

djangocms_stories-0.9.3.tar.gz (383.2 kB view details)

Uploaded Source

Built Distribution

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

djangocms_stories-0.9.3-py3-none-any.whl (400.7 kB view details)

Uploaded Python 3

File details

Details for the file djangocms_stories-0.9.3.tar.gz.

File metadata

  • Download URL: djangocms_stories-0.9.3.tar.gz
  • Upload date:
  • Size: 383.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djangocms_stories-0.9.3.tar.gz
Algorithm Hash digest
SHA256 36f35cc564a62dc1a09622924cdca77023f1f8656586afab251402967218ef36
MD5 0c13d98527d2519149f369fc13a3cb4c
BLAKE2b-256 26cb03d80e48b3076262192e993b81b8ab095f7106df09063988bfdb4310752a

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangocms_stories-0.9.3.tar.gz:

Publisher: publish-to-live-pypi.yml on django-cms/djangocms-stories

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djangocms_stories-0.9.3-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_stories-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8b913f33641bace648b19f6a7d65b2a90fae59fe26dd5a2108c1272236554343
MD5 646a9ecb5e622eea1e9418fb7f19c055
BLAKE2b-256 34fc287db74ff20fe745b750603e6f33d058655f04f324b3be393efe4d14b0dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for djangocms_stories-0.9.3-py3-none-any.whl:

Publisher: publish-to-live-pypi.yml on django-cms/djangocms-stories

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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