Django-minipub is a MINImalist PUBlication control system for Django.
Python HTML Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
example_project
minipub
scripts
.gitignore
.travis.yml
CHANGELOG.txt
LICENSE.txt
MANIFEST.in
README.rst
requirements.txt
setup.cfg
setup.py

README.rst

Django-minipub

Latest PyPI version https://travis-ci.org/richardbarran/django-minipub.svg?branch=master https://coveralls.io/repos/github/richardbarran/django-minipub/badge.svg?branch=master

Django-minipub is a mini-malist pub-lication control system for Django.

Let's explain it with an example: you have a 'news' application, with an Article model. In the admin interface, Minipub will add this fieldset:

docs/img/minipub-fieldset.png

All articles will then have the following 3 fields:

  • status: usually draft or published.
  • start: start date.
  • end: end date; optional.

Articles will only be visible in the public website if they are published and today's date is between the start and end dates.

In addition, we have a fieldset for showing various read-only status fields:

docs/img/minipub-status-fieldset.png

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

And that's it... Minipub is simply a few fields on a Model Mixin, together with plenty of code - in the models, views, admin and sitemap - to make the best use of it, that you will hopefully reuse again and again throughout a project.

What can I use it for?

Here are some examples of Minipub at work:

Alternatives

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.

Minipub is a very basic publication control tool, but works well on several production websites. Its author has found it be a decent compromise between a tool that's too basic to be useful, and too complex to be understood by its intended end users.

Installation and usage

Documentation Status

Please take a look at the documentation on ReadTheDocs.