https://github.com/bashu/django-permanent-helpers

🧟‍♂️ django admin helper classes for django-permanent models
https://github.com/bashu/django-permanent-helpers

django django-permanent

Last synced: 10 months ago
JSON representation

🧟‍♂️ django admin helper classes for django-permanent models

• Host: GitHub
• URL: https://github.com/bashu/django-permanent-helpers
• Owner: bashu
• License: mit
• Created: 2017-01-03T04:52:33.000Z (about 9 years ago)
• Default Branch: develop
• Last Pushed: 2021-11-29T07:05:44.000Z (about 4 years ago)
• Last Synced: 2025-04-09T19:16:53.638Z (10 months ago)
• Topics: django, django-permanent
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
django-permanent-helpers

========================

.. image:: https://img.shields.io/pypi/v/django-permanent-helpers.svg

    :target: https://pypi.python.org/pypi/django-permanent-helpers/

.. image:: https://img.shields.io/pypi/dm/django-permanent-helpers.svg

    :target: https://pypi.python.org/pypi/django-permanent-helpers/

.. image:: https://img.shields.io/github/license/bashu/django-permanent-helpers.svg

    :target: https://pypi.python.org/pypi/django-permanent-helpers/

Django admin helper classes for django-permanent_ models.

Authored by `Basil Shubin `_, inspired by django-taggit-helpers_

Installation

------------

First install the module, preferably in a virtual environment. It can be installed from PyPI:

.. code-block:: shell

    pip install django-permanent-helpers

Setup

-----

First make sure the project is configured for django-permanent_.

Then add the following settings:

.. code-block:: python

    INSTALLED_APPS += (

        'django_permanent_helpers',

    )

Usage

-----

PermanentModelAdmin

~~~~~~~~~~~~~~~~~~~

An abstract ModelAdmin which will include deleted objects in its listing and enable un-deleting feature.

.. code-block:: python

    from django_permanent_helpers.admin import PermanentModelAdmin

    class MyModelAdmin(PermanentModelAdmin):

        pass

PermanentModelListFilter

~~~~~~~~~~~~~~~~~~~~~~~~

Filter records by their ``PERMANENT_FIELD`` value, use together with ``PermanentModelAdmin`` class.

.. code-block:: python

    from django_permanent_helpers.admin import PermanentModelAdmin, PermanentModelListFilter

    class MyModelAdmin(PermanentModelAdmin):

        list_filter = [PermanentModelListFilter]

Contributing

------------

If you like this module, forked it, or would like to improve it, please let us know!

Pull requests are welcome too. :-)

License

-------

``django-permanent-helpers`` is released under the MIT license.

.. _django-permanent: https://github.com/meteozond/django-permanent

.. _django-taggit-helpers: https://github.com/mfcovington/django-taggit-helpers