Metadata-Version: 2.4
Name: djangocms-moderation
Version: 2.4.0
Summary: Provide moderation workflows for content in Django CMS
Author-email: Divio AG <info@divio.ch>
Maintainer-email: Django CMS Association and contributors <info@django-cms.org>
License: BSD
Project-URL: Homepage, https://github.com/django-cms/djangocms-moderation
Project-URL: Repository, https://github.com/django-cms/djangocms-moderation
Project-URL: Documentation, https://github.com/django-cms/djangocms-moderation
Project-URL: Bug Tracker, https://github.com/django-cms/djangocms-moderation/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django CMS
Classifier: Framework :: Django CMS :: 4.1
Classifier: Framework :: Django CMS :: 5.0
Classifier: Framework :: Django CMS :: 5.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: djangocms-versioning
Requires-Dist: django-treebeard
Requires-Dist: django-sekizai>=0.7
Requires-Dist: django-admin-sortable2>=0.6.4
Provides-Extra: test
Requires-Dist: coverage[toml]; extra == "test"
Requires-Dist: django-simple-captcha; extra == "test"
Requires-Dist: djangocms-alias>=2.0.0; extra == "test"
Requires-Dist: djangocms-text; extra == "test"
Requires-Dist: djangocms-admin-style; extra == "test"
Requires-Dist: factory-boy; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-django; extra == "test"
Dynamic: license-file

*********************
django CMS Moderation
*********************

django CMS Moderation adds editorial approval workflows to django CMS: draft
content is gathered into collections, routed through configurable review steps,
and published only once the right people have signed it off. It builds on
`djangocms-versioning <https://github.com/django-cms/djangocms-versioning>`_.

=============
Documentation
=============

Full documentation — tutorial, how-to guides, a complete settings reference and
background explanation — is published at
`djangocms-moderation.readthedocs.io <https://djangocms-moderation.readthedocs.io>`_.

New to moderation? Start with the `quick-start tutorial
<https://djangocms-moderation.readthedocs.io/en/latest/tutorial/quickstart.html>`_,
which takes you from an empty project to a published page in about ten minutes.

============
Installation
============

django CMS Moderation requires a django CMS 4.1 (or higher) project, with
`djangocms-versioning <https://github.com/django-cms/djangocms-versioning>`_
installed.

Run::

    pip install djangocms-moderation

Add the following to your project's ``INSTALLED_APPS``:

- ``'djangocms_moderation'``
- ``'adminsortable2'``

Then run the application's database migrations::

    python manage.py migrate djangocms_moderation

For the full set-up, see the `installation guide
<https://djangocms-moderation.readthedocs.io/en/latest/howto/installation.html>`_.
All configuration options are documented in the `settings reference
<https://djangocms-moderation.readthedocs.io/en/latest/reference/settings.html>`_.

============
Contributing
============

The documentation sources live under ``docs/`` in reStructuredText format. To
build and preview the HTML locally::

    cd docs/
    make html

The generated files appear under ``docs/_build/html`` and can be opened in a
browser. The published site on Read the Docs is rebuilt automatically from the
``docs/`` sources.
