Skip to main content

News / blog plugin for the Wagtail CMS

Project description

A plugin for Wagtail that provides news / blogging functionality.

Installing

Install using pip:

pip install wagtailnews

It works with Wagtail 5.2 and upwards. For older versions of Wagtail see past releases.

Quick start

Create news models for your application that inherit from the relevant wagtailnews models:

from django.db import models

from wagtail.admin.panels import FieldPanel
from wagtail.fields import RichTextField
from wagtail.models import Page

from wagtailnews.models import NewsIndexMixin, AbstractNewsItem, AbstractNewsItemRevision
from wagtailnews.decorators import newsindex


# The decorator registers this model as a news index
@newsindex
class NewsIndex(NewsIndexMixin, Page):
    # Add extra fields here, as in a normal Wagtail Page class, if required
    newsitem_model = 'NewsItem'

    featured_news_item = models.ForeignKey(
        'NewsItem',
        null=True,
        blank=True,
        on_delete=models.SET_NULL,
        related_name='+',
    )

    content_panels = Page.content_panels + [
        FieldPanel('featured_news_item'), # This will set up a chooser for selecting a news item
    ]


class NewsItem(AbstractNewsItem):
    # NewsItem is a normal Django model, *not* a Wagtail Page.
    # Add any fields required for your page.
    # It already has ``date`` field, and a link to its parent ``NewsIndex`` Page
    title = models.CharField(max_length=255)
    body = RichTextField()

    panels = [
        FieldPanel('title', classname='full title'),
        FieldPanel('body', classname='full'),
    ] + AbstractNewsItem.panels

    def __str__(self):
        return self.title


class NewsItemRevision(AbstractNewsItemRevision):
    newsitem = models.ForeignKey(NewsItem, related_name='revisions', on_delete=models.CASCADE)

Old docs

The docs for Wagtail news are severely out of date, but may still be useful for reference.

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

wagtailnews-5.2.0.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

wagtailnews-5.2.0-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

Details for the file wagtailnews-5.2.0.tar.gz.

File metadata

  • Download URL: wagtailnews-5.2.0.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for wagtailnews-5.2.0.tar.gz
Algorithm Hash digest
SHA256 75e5be8743a76eba2d2671e993494d1c36f61258066968acdc595a681607b5fb
MD5 1213e455aafe4d0727d2575d997605e6
BLAKE2b-256 634f45044671542d60f58e1dfc0fdfc255cbe5811345b09001b0f3dbcd7f18bb

See more details on using hashes here.

Provenance

File details

Details for the file wagtailnews-5.2.0-py3-none-any.whl.

File metadata

  • Download URL: wagtailnews-5.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for wagtailnews-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5d58d8046463b9679361f3ea1ee12ee6493e4956dfee579f084d168eb62a4f0
MD5 486da489adea39e7ced4080e623b2314
BLAKE2b-256 754be4adb8b92679c07a514e7d7770356c0aa234ff55b050822574c8f87ebc32

See more details on using hashes here.

Provenance

Supported by

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