Skip to main content

Boilerplate for creating publishable lists of objects

Project description


.. image::
:alt: Latest PyPI version

.. image::
:alt: Number of PyPI downloads

.. image::

Django-mininews is a basic tool for controlling the *publication* of objects.

Let's take an example: you have a 'news' application, that just consists of a
Article model. In the admin interface, we have this fieldset:

.. image:: docs/img/mininews-fieldset.png

All articles have the following 3 fields:

- status: usually 'draft' or 'published'.
- start: start date, defaults to whenever the status is changed to ``published``.
- end: end date; optional.

Articles can only be viewed in the public website **if** they are ``published``
**and** between the start and end dates.

Oh, we also have a fieldset for showing various read-only status fields:

.. image:: docs/img/mininews-status-fieldset.png

These can be of use for tracking changes to an Article.

And that's it... Mininews is just an abstract Model, together with plenty of code to make
the best use of it, that you will reuse again and again throughout a project.

What can I use it for?
Here are some examples of Mininews at work:

- `Minutes of the meetings of an association <>`_.
- `Controlling the publication of the Events at a well-known racetrack <>`_.
- `Controlling when job offers are displayed <>`_.

This is a very basic publication control tool, but works well on several production
websites. There are several similar projects that take slightly different approaches
to publication control; usually they introduce more sophisticated control. A well-known
example is `django-reversion <>`_.

Installation and usage
.. image::
:alt: Documentation Status
Please take a look at
`the documentation <>`_ on ReadTheDocs.

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 (13.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page