djangocms-moderation 2.2.2__tar.gz

djangocms_moderation-2.2.2/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2017, Divio AG
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Divio AG nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL DIVIO AG BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

djangocms_moderation-2.2.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE.txt
+include README.rst
+recursive-include djangocms_moderation/templates *
+recursive-include djangocms_moderation/static *
+recursive-exclude * *.pyc

djangocms_moderation-2.2.2/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.2
+Name: djangocms-moderation
+Version: 2.2.2
+Home-page: https://github.com/django-cms/djangocms-moderation
+Author: Divio AG
+Author-email: info@divio.ch
+Maintainer: Django CMS Association and contributors
+Maintainer-email: info@django-cms.org
+License: BSD
+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.0
+Classifier: Framework :: Django CMS :: 4.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development
+License-File: LICENSE.txt
+Requires-Dist: Django>=3.2
+Requires-Dist: django-cms
+Requires-Dist: django-sekizai>=0.7
+Requires-Dist: django-admin-sortable2>=0.6.4
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+
+*********************
+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.

djangocms_moderation-2.2.2/README.rst

@@ -0,0 +1,108 @@
+*********************
+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.

djangocms_moderation-2.2.2/djangocms_moderation/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.2.2"