Metadata-Version: 2.4
Name: django-cms-helpers
Version: 3.0.0
Summary: django-cms-helpers is a collection of helpers when working with django-cms.
License: MIT
License-File: LICENSE.rst
Author: Stephan Jaekel
Author-email: steph@rdev.info
Requires-Python: >=3.10,<4
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: docs
Requires-Dist: Django (>=4.2)
Requires-Dist: Sphinx (>=5.1) ; extra == "docs"
Requires-Dist: django-anylink (>=3.0) ; extra == "docs"
Requires-Dist: django-cms (>=4.1,<5)
Requires-Dist: django-filer (>=3.3) ; extra == "docs"
Requires-Dist: djangocms-versioning (>=2.0)
Project-URL: Homepage, https://github.com/stephrdev/django-cms-helpers
Project-URL: Repository, https://github.com/stephrdev/django-cms-helpers
Description-Content-Type: text/x-rst

django-cms-helpers
==================

.. image:: https://img.shields.io/pypi/v/django-cms-helpers.svg
   :target: https://pypi.org/project/django-cms-helpers/
   :alt: Latest Version

.. image:: https://github.com/stephrdev/django-cms-helpers/workflows/Test/badge.svg?branch=master
   :target: https://github.com/stephrdev/django-cms-helpers/actions?workflow=Test
   :alt: CI Status

.. image:: https://codecov.io/gh/stephrdev/django-cms-helpers/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/stephrdev/django-cms-helpers
   :alt: Coverage Status

.. image:: https://readthedocs.org/projects/django-cms-helpers/badge/?version=latest
   :target: https://django-cms-helpers.readthedocs.io/en/stable/?badge=latest
   :alt: Documentation Status


django-cms-helpers is a collection of helpers when working with django-cms.


Features
--------

* templatetag for getting title extension object.
* anylink extension for cms pages.
* boilerplate code for ExtensionToolbar.
* FilerFileField extension to validate file extension and make default_alt_text required.

Requirements
------------

django-cms-helpers supports Python 3 only and requires at least Django 4.2, django CMS 4.1
and djangocms-versioning 2.0. For django CMS 3.x support, use the 2.x release series.


Prepare for development
-----------------------

A Python 3.10+ interpreter is required in addition to poetry.

.. code-block:: shell

    $ poetry install


Now you're ready to run the tests:

.. code-block:: shell

    $ poetry run py.test


Resources
---------

* `Documentation <https://django-cms-helpers.readthedocs.io>`_
* `Bug Tracker <https://github.com/stephrdev/django-cms-helpers/issues>`_
* `Code <https://github.com/stephrdev/django-cms-helpers/>`_

