*********************
django CMS Moderation
*********************
============
Installation
============
Requirements
============
django CMS Moderation requires that you have a django CMS 4.0 (or higher) project already running and set up.
djangocms-versioning is also required along with django-fsm which should be installed with versioning.
To install
==========
Run::
pip install git+git://github.com/django-cms/djangocms-moderation@master#egg=djangocms-moderation
Add the following to your project's ``INSTALLED_APPS``:
- ``'djangocms_moderation'``
- ``'adminsortable2'``
Run::
python manage.py migrate djangocms_moderation
to perform the application's database migrations.
Configuration
=============
The following settings can be added to your project's settings file to configure django CMS Moderation's behavior:
.. list-table::
:header-rows: 1
:widths: 50 50
* - Setting
- Description
* - ``CMS_MODERATION_DEFAULT_COMPLIANCE_NUMBER_BACKEND``
- Default backend class for generating compliance numbers.
Default is ``djangocms_moderation.backends.uuid4_backend``.
* - ``CMS_MODERATION_COMPLIANCE_NUMBER_BACKENDS``
- List of available compliance number backend classes.
By default, three backends are configured: ``uuid4_backend``,
``sequential_number_backend``, and
``sequential_number_with_identifier_prefix_backend``.
* - ``CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE``
- Enable/disable workflow override functionality. Defaults to ``False``.
* - ``CMS_MODERATION_DEFAULT_CONFIRMATION_PAGE_TEMPLATE``
- Default template for confirmation pages. Defaults to
``djangocms_moderation/moderation_confirmation.html``
* - ``CMS_MODERATION_CONFIRMATION_PAGE_TEMPLATES``
- List of available confirmation page templates. Only includes the
default template by default.
* - ``CMS_MODERATION_COLLECTION_COMMENTS_ENABLED``
- Enable/disable comments on collections. Defaults to ``True``.
* - ``CMS_MODERATION_REQUEST_COMMENTS_ENABLED``
- Enable/disable comments on requests. Defaults to ``True``.
* - ``CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT``
- Maximum length for collection names. Defaults to ``24``.
* - ``EMAIL_NOTIFICATIONS_FAIL_SILENTLY``
- Control email notification error handling. Defaults to ``False``.
Example Configuration
---------------------
Add these settings to your project's settings file:
.. code-block:: python
# Custom compliance number backend
CMS_MODERATION_DEFAULT_COMPLIANCE_NUMBER_BACKEND = 'myapp.backends.CustomComplianceNumberBackend'
# Enable workflow override
CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE = True
# Custom confirmation template
CMS_MODERATION_DEFAULT_CONFIRMATION_PAGE_TEMPLATE = 'custom_confirmation.html'
# Enable comments
CMS_MODERATION_COLLECTION_COMMENTS_ENABLED = True
CMS_MODERATION_REQUEST_COMMENTS_ENABLED = True
# Set collection name length limit
CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT = 100
# Control email notification errors
EMAIL_NOTIFICATIONS_FAIL_SILENTLY = False
=============
Documentation
=============
We maintain documentation under ``docs`` folder using rst format. HTML documentation can be generated using the following commands
Run::
cd docs/
make html
This should generate all html files from rst documents under the `docs/_build` folder, which can be browsed.
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-moderation",
"name": "djangocms-moderation",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": null,
"maintainer_email": "info@django-cms.org",
"keywords": null,
"author": "Divio AG",
"author_email": "info@divio.ch",
"download_url": "https://files.pythonhosted.org/packages/78/68/49398b5b5d14629e113378c0db1c3e5ee670f6b967590c9ba7e84e39f211/djangocms_moderation-2.2.2.tar.gz",
"platform": null,
"description": "*********************\ndjango CMS Moderation\n*********************\n\n============\nInstallation\n============\n\nRequirements\n============\n\ndjango CMS Moderation requires that you have a django CMS 4.0 (or higher) project already running and set up.\n\ndjangocms-versioning is also required along with django-fsm which should be installed with versioning.\n\n\nTo install\n==========\n\nRun::\n\n pip install git+git://github.com/django-cms/djangocms-moderation@master#egg=djangocms-moderation\n\nAdd the following to your project's ``INSTALLED_APPS``:\n\n- ``'djangocms_moderation'``\n- ``'adminsortable2'``\n\nRun::\n\n python manage.py migrate djangocms_moderation\n\nto perform the application's database migrations.\n\nConfiguration\n=============\n\nThe following settings can be added to your project's settings file to configure django CMS Moderation's behavior:\n\n.. list-table::\n :header-rows: 1\n :widths: 50 50\n\n * - Setting\n - Description\n * - ``CMS_MODERATION_DEFAULT_COMPLIANCE_NUMBER_BACKEND``\n - Default backend class for generating compliance numbers.\n Default is ``djangocms_moderation.backends.uuid4_backend``.\n * - ``CMS_MODERATION_COMPLIANCE_NUMBER_BACKENDS``\n - List of available compliance number backend classes.\n By default, three backends are configured: ``uuid4_backend``,\n ``sequential_number_backend``, and\n ``sequential_number_with_identifier_prefix_backend``.\n * - ``CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE``\n - Enable/disable workflow override functionality. Defaults to ``False``.\n * - ``CMS_MODERATION_DEFAULT_CONFIRMATION_PAGE_TEMPLATE``\n - Default template for confirmation pages. Defaults to\n ``djangocms_moderation/moderation_confirmation.html``\n * - ``CMS_MODERATION_CONFIRMATION_PAGE_TEMPLATES``\n - List of available confirmation page templates. Only includes the\n default template by default.\n * - ``CMS_MODERATION_COLLECTION_COMMENTS_ENABLED``\n - Enable/disable comments on collections. Defaults to ``True``.\n * - ``CMS_MODERATION_REQUEST_COMMENTS_ENABLED``\n - Enable/disable comments on requests. Defaults to ``True``.\n * - ``CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT``\n - Maximum length for collection names. Defaults to ``24``.\n * - ``EMAIL_NOTIFICATIONS_FAIL_SILENTLY``\n - Control email notification error handling. Defaults to ``False``.\n\nExample Configuration\n---------------------\n\nAdd these settings to your project's settings file:\n\n.. code-block:: python\n\n # Custom compliance number backend\n CMS_MODERATION_DEFAULT_COMPLIANCE_NUMBER_BACKEND = 'myapp.backends.CustomComplianceNumberBackend'\n\n # Enable workflow override\n CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE = True\n\n # Custom confirmation template\n CMS_MODERATION_DEFAULT_CONFIRMATION_PAGE_TEMPLATE = 'custom_confirmation.html'\n\n # Enable comments\n CMS_MODERATION_COLLECTION_COMMENTS_ENABLED = True\n CMS_MODERATION_REQUEST_COMMENTS_ENABLED = True\n\n # Set collection name length limit\n CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT = 100\n\n # Control email notification errors\n EMAIL_NOTIFICATIONS_FAIL_SILENTLY = False\n\n=============\nDocumentation\n=============\n\nWe maintain documentation under ``docs`` folder using rst format. HTML documentation can be generated using the following commands\n\nRun::\n\n cd docs/\n make html\n\nThis should generate all html files from rst documents under the `docs/_build` folder, which can be browsed.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": null,
"version": "2.2.2",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-moderation"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "89bd5fd2b875ffc06dc848c3bbbd6bd58cc7f6c75f70d6b257beffc0c52ab6bb",
"md5": "75aaae16a3a849eab6c9e21a1b9e5e2a",
"sha256": "3a28dfe342e6f119b656ceee79fbcc848a1d0fb7f27c94c2976963f282420df9"
},
"downloads": -1,
"filename": "djangocms_moderation-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "75aaae16a3a849eab6c9e21a1b9e5e2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 572887,
"upload_time": "2025-02-03T20:41:56",
"upload_time_iso_8601": "2025-02-03T20:41:56.081758Z",
"url": "https://files.pythonhosted.org/packages/89/bd/5fd2b875ffc06dc848c3bbbd6bd58cc7f6c75f70d6b257beffc0c52ab6bb/djangocms_moderation-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "786849398b5b5d14629e113378c0db1c3e5ee670f6b967590c9ba7e84e39f211",
"md5": "8d0067ef9f4a3c17f54f0983393eb489",
"sha256": "1211d98e7b5378bb9a35f0173793e16fe9423c9dae1b41560274a9b93b6ea852"
},
"downloads": -1,
"filename": "djangocms_moderation-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "8d0067ef9f4a3c17f54f0983393eb489",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 511487,
"upload_time": "2025-02-03T20:41:57",
"upload_time_iso_8601": "2025-02-03T20:41:57.726774Z",
"url": "https://files.pythonhosted.org/packages/78/68/49398b5b5d14629e113378c0db1c3e5ee670f6b967590c9ba7e84e39f211/djangocms_moderation-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 20:41:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-moderation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "djangocms-moderation"
}
JSON
