django-cache-cleaner 0.1.0__py3-none-any.whl

cache_cleaner/admin.py

@@ -0,0 +1,37 @@
+from django.contrib import admin, messages
+from django.core.cache import caches
+from django.utils.translation import gettext_lazy as _
+
+from cache_cleaner.models import Cache
+
+
+@admin.action(description=_("Clear selected caches"))
+def clear_caches(modeladmin, request, queryset):
+    for cache_obj in queryset:
+        cache_name = cache_obj.name
+        cache = caches[cache_name]
+        cache.clear()
+    caches_names = [cache_obj.name for cache_obj in queryset]
+    caches_names_str = ", ".join(caches_names)
+    messages.success(request, _("Cleared caches:") + f" {caches_names_str}.")
+
+
+@admin.register(Cache)
+class CacheAdmin(admin.ModelAdmin):
+    search_fields = ("name",)
+    list_display = ("name",)
+    actions = [clear_caches]
+    show_full_result_count = False
+
+    def get_queryset(self, request):
+        Cache.update_from_settings()
+        return super().get_queryset(request)
+
+    def has_add_permission(self, request, obj=None):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False

cache_cleaner/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class CacheCleanerConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "cache_cleaner"
+    verbose_name = _("Cache Cleaner")

cache_cleaner/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,42 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-06-25 14:47-0500\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+#: cache_cleaner/admin.py
+msgid "Clear selected caches"
+msgstr ""
+
+#: cache_cleaner/admin.py
+msgid "Cleared caches:"
+msgstr "Cleared caches:"
+
+#: cache_cleaner/apps.py
+msgid "Cache Cleaner"
+msgstr "Cache Cleaner"
+
+#: cache_cleaner/models.py
+msgid "Cache"
+msgstr "Cache"
+
+#: cache_cleaner/models.py
+msgid "Caches"
+msgstr "Caches"
+
+#: cache_cleaner/models.py
+msgid "Name"
+msgstr "Name"

cache_cleaner/locale/it/LC_MESSAGES/django.po

@@ -0,0 +1,42 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-06-25 14:47-0500\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+#: cache_cleaner/admin.py
+msgid "Clear selected caches"
+msgstr ""
+
+#: cache_cleaner/admin.py
+msgid "Cleared caches:"
+msgstr "Cleared caches:"
+
+#: cache_cleaner/apps.py
+msgid "Cache Cleaner"
+msgstr "Cache Cleaner"
+
+#: cache_cleaner/models.py
+msgid "Cache"
+msgstr "Cache"
+
+#: cache_cleaner/models.py
+msgid "Caches"
+msgstr "Caches"
+
+#: cache_cleaner/models.py
+msgid "Name"
+msgstr "Nome"

cache_cleaner/management/commands/clear_cache.py

@@ -0,0 +1,76 @@
+from django.core.cache import cache, caches
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+    """
+    A Django management command to clear the cache.
+    This command allows you to clear the entire cache or individual caches.
+
+    Options:
+        cache_names (list, optional): A list of one or more cache names to clear.
+        --all (bool, optional): A flag to clear all defined cache backends.
+    """
+
+    help = "Clear the entire cache or individual caches."
+
+    def _stdout_success(self, message):
+        self.stdout.write(self.style.SUCCESS(message))
+
+    def _stdout_error(self, message):
+        self.stderr.write(self.style.ERROR(message))
+
+    def add_arguments(self, parser):
+        """
+        Adds arguments to the command parser.
+
+        * cache_names: A list of cache names to clear.
+        * --all: A flag to clear all caches.
+        """
+        parser.add_argument(
+            "cache_names",
+            nargs="*",
+            type=str,
+            help="List of specific cache names to clear",
+        )
+        parser.add_argument(
+            "--all",
+            action="store_true",
+            dest="clear_all",
+            help="Clear all caches",
+        )
+
+    def _clear_all_caches(self):
+        for cache_name in caches:
+            caches[cache_name].clear()
+            self._stdout_success(f"Cleared cache '{cache_name}'!")
+        self._stdout_success("Cleared all caches!")
+
+    def _clear_default_cache(self):
+        cache.clear()
+        self._stdout_success("Cleared default cache!")
+
+    def _clear_individual_caches(self, cache_names):
+        for cache_name in cache_names:
+            if cache_name in caches:
+                caches[cache_name].clear()
+                self._stdout_success(f"Cleared cache '{cache_name}'!")
+            else:
+                self._stdout_error(f"Cache '{cache_name}' does not exist!")
+
+    def handle(self, *args, **options):
+        """
+        Handles the cache clearing based on the provided arguments.
+
+        * If `clear_all` is True, clears all defined cache backends.
+        * If specific `cache_names` are provided, clears those caches if they exist.
+        * If no arguments are provided, clears the default cache.
+        """
+        cache_names = options["cache_names"]
+        clear_all = options["clear_all"]
+        if clear_all:
+            self._clear_all_caches()
+        elif cache_names:
+            self._clear_individual_caches(cache_names)
+        else:
+            self._clear_default_cache()

cache_cleaner/metadata.py

@@ -0,0 +1,10 @@
+__author__ = "Fabio Caccamo"
+__copyright__ = "Copyright (c) 2024-present Fabio Caccamo"
+__description__ = (
+    "clear the entire cache or individual caches easily "
+    "using the admin panel or management command."
+)
+__email__ = "fabio.caccamo@gmail.com"
+__license__ = "MIT"
+__title__ = "django-cache-cleaner"
+__version__ = "0.1.0"

cache_cleaner/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Cache",
+            fields=[
+                (
+                    "name",
+                    models.CharField(
+                        max_length=255,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="Name",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Cache",
+                "verbose_name_plural": "Caches",
+                "ordering": ["name"],
+            },
+        ),
+    ]

cache_cleaner/models.py

@@ -0,0 +1,35 @@
+from django.conf import settings
+from django.db import models, transaction
+from django.utils.translation import gettext_lazy as _
+
+
+class Cache(models.Model):
+    class Meta:
+        ordering = ["name"]
+        verbose_name = _("Cache")
+        verbose_name_plural = _("Caches")
+
+    @classmethod
+    def update_from_settings(cls):
+        manager = cls.objects
+        settings_caches = set(settings.CACHES.keys())
+        existing_caches = set(manager.values_list("name", flat=True))
+        caches_to_create = settings_caches - existing_caches
+        caches_to_delete = existing_caches - settings_caches
+
+        with transaction.atomic():
+            if caches_to_create:
+                manager.bulk_create(
+                    [Cache(name=cache_name) for cache_name in caches_to_create]
+                )
+            if caches_to_delete:
+                manager.filter(name__in=caches_to_delete).delete()
+
+    name = models.CharField(
+        verbose_name=_("Name"),
+        primary_key=True,
+        max_length=255,
+    )
+
+    def __str__(self):
+        return f"{self.name}"

django_cache_cleaner-0.1.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Fabio Caccamo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_cache_cleaner-0.1.0.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.1
+Name: django-cache-cleaner
+Version: 0.1.0
+Summary: clear the entire cache or individual caches easily using the admin panel or management command.
+Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
+Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024-present Fabio Caccamo
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fabiocaccamo/django-cache-cleaner
+Project-URL: Download, https://github.com/fabiocaccamo/django-cache-cleaner/releases
+Project-URL: Documentation, https://github.com/fabiocaccamo/django-cache-cleaner#readme
+Project-URL: Issues, https://github.com/fabiocaccamo/django-cache-cleaner/issues
+Project-URL: Funding, https://github.com/sponsors/fabiocaccamo/
+Project-URL: Twitter, https://twitter.com/fabiocaccamo
+Keywords: django,cache,caches,cleaner,clear,clean,cleanup,command,management,purge
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+[![](https://img.shields.io/pypi/pyversions/django-cache-cleaner.svg?color=3776AB&logo=python&logoColor=white)](https://www.python.org/)
+[![](https://img.shields.io/pypi/djversions/django-cache-cleaner?color=0C4B33&logo=django&logoColor=white&label=django)](https://www.djangoproject.com/)
+
+[![](https://img.shields.io/pypi/v/django-cache-cleaner.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/django-cache-cleaner/)
+[![](https://static.pepy.tech/badge/django-cache-cleaner/month)](https://pepy.tech/project/django-cache-cleaner)
+[![](https://img.shields.io/github/stars/fabiocaccamo/django-cache-cleaner?logo=github&style=flat)](https://github.com/fabiocaccamo/django-cache-cleaner/stargazers)
+[![](https://img.shields.io/pypi/l/django-cache-cleaner.svg?color=blue)](https://github.com/fabiocaccamo/django-cache-cleaner/blob/main/LICENSE.txt)
+
+[![](https://results.pre-commit.ci/badge/github/fabiocaccamo/django-cache-cleaner/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/django-cache-cleaner/main)
+[![](https://img.shields.io/github/actions/workflow/status/fabiocaccamo/django-cache-cleaner/test-package.yml?branch=main&label=build&logo=github)](https://github.com/fabiocaccamo/django-cache-cleaner)
+[![](https://img.shields.io/codecov/c/gh/fabiocaccamo/django-cache-cleaner?logo=codecov)](https://codecov.io/gh/fabiocaccamo/django-cache-cleaner)
+<!-- [![](https://img.shields.io/codacy/grade/{id}?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/django-cache-cleaner) -->
+[![](https://img.shields.io/codeclimate/maintainability/fabiocaccamo/django-cache-cleaner?logo=code-climate)](https://codeclimate.com/github/fabiocaccamo/django-cache-cleaner/)
+[![](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=black)](https://github.com/psf/black)
+[![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+# django-cache-cleaner
+clear the entire cache or individual caches easily using the admin panel or management command.
+
+## Installation
+-   Run `pip install django-cache-cleaner`
+-   Add `cache_cleaner` to `settings.INSTALLED_APPS`
+-   Run `python manage.py migrate`
+-   Restart your application server
+
+## Usage
+
+### Admin
+To clear caches using the admin panel:
+-   ➡️ Navigate to the `Cache Cleaner / Caches`
+-   ✔️ Check the caches you want to clear
+-   🧹 Select "Clear selected caches" from the actions menu
+-   ✨ Done :)
+
+### Command
+This package doesn't need any setting.
+
+#### Clear default cache
+```python
+python manage.py clear_cache
+```
+
+#### Clear individual caches
+```python
+python manage.py clear_cache news products
+```
+
+#### Clear all caches
+```python
+python manage.py clear_cache --all
+```
+
+## Testing
+```bash
+# clone repository
+git clone https://github.com/fabiocaccamo/django-cache-cleaner.git && cd django-cache-cleaner
+
+# create virtualenv and activate it
+python -m venv venv && . venv/bin/activate
+
+# upgrade pip
+python -m pip install --upgrade pip
+
+# install requirements
+pip install -r requirements.txt -r requirements-test.txt
+
+# install pre-commit to run formatters and linters
+pre-commit install --install-hooks
+
+# run tests
+tox
+# or
+python runtests.py
+# or
+python -m django test --settings "tests.settings"
+```
+
+
+## License
+Released under [MIT License](LICENSE.txt).
+
+---
+
+## Supporting
+
+- :star: Star this project on [GitHub](https://github.com/fabiocaccamo/django-cache-cleaner)
+- :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)
+- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)
+- :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)
+
+## See also
+
+- [`django-admin-interface`](https://github.com/fabiocaccamo/django-admin-interface) - the default admin interface made customizable by the admin itself. popup windows replaced by modals. 🧙 ⚡
+
+- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨
+
+- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. ⚙️
+
+- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. 🚧 🛠️
+
+- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. ↪️
+
+- [`django-treenode`](https://github.com/fabiocaccamo/django-treenode) - probably the best abstract model / admin for your tree based stuff. 🌳
+
+- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘
+
+- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳
+
+- [`python-fontbro`](https://github.com/fabiocaccamo/python-fontbro) - friendly font operations. 🧢
+
+- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. 🧟‍♂️

django_cache_cleaner-0.1.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+cache_cleaner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cache_cleaner/admin.py,sha256=dA-0HiXCXCNxCJ_-DsNQXYADaIwVTPzVpjKcgLyANkE,1126
+cache_cleaner/apps.py,sha256=8uUbBOW9qq1G8H0SnC8UMedblBb1y7R5frODFjE2FkU,250
+cache_cleaner/metadata.py,sha256=jeNSmocCFYD44Tr20BbxDn0utk1u2ONk5dq69LK2Hwo,334
+cache_cleaner/models.py,sha256=XT6oJ1axCla-TMWjk1uRGQbDxNeCKfUTFA2gmf02gUw,1084
+cache_cleaner/locale/en/LC_MESSAGES/django.mo,sha256=aQuJZjsNhY7crgdLLvHE4sk4jyqcYuy61rx6Y0ZikA4,588
+cache_cleaner/locale/en/LC_MESSAGES/django.po,sha256=CHO0EvzD4rmLAAo6S79jD6RrPOzbwps5wg-tXdxte48,1011
+cache_cleaner/locale/it/LC_MESSAGES/django.mo,sha256=44afawLpQ80g6qbXWBa0yVpE_FtLRvsv0-g8db3pITQ,588
+cache_cleaner/locale/it/LC_MESSAGES/django.po,sha256=jaPDkTjowx74i7f9NvD3sommOvOQ_JxgfwrLE4eIUnk,1011
+cache_cleaner/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cache_cleaner/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cache_cleaner/management/commands/clear_cache.py,sha256=5wH4OdzwWsyIe3s6mjXjV_dlpGDBrWObk-eIoHaCtPo,2539
+cache_cleaner/migrations/0001_initial.py,sha256=1_5RU19RGIbsbLvY-msVRn_59aTaALBd8DmXWc7N2ZU,714
+cache_cleaner/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_cache_cleaner-0.1.0.dist-info/LICENSE.txt,sha256=qrm28nhEZ93_njjhXRaNRgs3oTewj0nkG5M5OMF3Md4,1078
+django_cache_cleaner-0.1.0.dist-info/METADATA,sha256=klcggWs9Lb6pSaqppS2_GAl7DT5_HOJidXrgkTnnBAg,8278
+django_cache_cleaner-0.1.0.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+django_cache_cleaner-0.1.0.dist-info/top_level.txt,sha256=3xFKzYLYt69DmArlh6ty8Y-dNPag-bK7tz1WS6fL5z0,14
+django_cache_cleaner-0.1.0.dist-info/RECORD,,

django_cache_cleaner-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.1.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_cache_cleaner-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cache_cleaner