django-admin-contexts 0.2.0__tar.gz

django_admin_contexts-0.2.0/.gitignore

@@ -0,0 +1,92 @@
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Basics
+*.py[cod]
+__pycache__
+
+# Logs
+*.log
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+coverage.json
+coverage.xml
+.tox
+nosetests.xml
+htmlcov
+
+# Translations
+*.mo
+*.pot
+
+# Pycharm
+.idea/*
+
+# Vim
+
+*~
+*.swp
+*.swo
+
+# npm
+node_modules/
+
+# Compass
+.sass-cache
+
+# virtual environments
+.env
+
+# User-uploaded media
+matorral/media/
+staticfiles/
+
+# Hitch directory
+tests/.hitch
+
+# sqlite db
+*.db
+*.db-journal
+
+# celery beat
+celerybeat-schedule.db
+celerybeat.pid
+
+# pyenv
+.python-version
+
+.idea
+
+.editorconfig
+
+matorral.egg-info/
+.pytest_cache/
+celerybeat-schedule
+
+TODO.md
+
+data/
+
+# Build files
+dist/
+build/

django_admin_contexts-0.2.0/AUTHORS.md

@@ -0,0 +1,7 @@
+# Primary Authors
+
+- Matias Agustin Mendez (https://github.com/matagus)
+
+# Contributors
+
+No contributions yet.

django_admin_contexts-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present, Matias Agustin Mendez and django-admin-contexts contributors
+
+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_admin_contexts-0.2.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.3
+Name: django-admin-contexts
+Version: 0.2.0
+Summary: Contexts for Django Admin homepage
+Project-URL: Homepage, https://github.com/matagus/django-admin-contexts
+Project-URL: Issues, https://.github.com/matagus/django-admin-contexts/issues
+Project-URL: Repository, https://github.com/matagus/django-admin-contexts
+Project-URL: Changelog, https://githib.com/matagus/django-admin-contexts/releases
+Project-URL: Pypi, https://pypi.org/project/django-admin-contexts
+Author-email: Matias Agustin Mendez <matagus@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: AUTHORS.md
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+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 :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Requires-Dist: django>=4.0
+Provides-Extra: dev
+Requires-Dist: django-debug-toolbar; extra == 'dev'
+Requires-Dist: django-extensions; extra == 'dev'
+Requires-Dist: ipython; extra == 'dev'
+Requires-Dist: werkzeug; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# django-admin-contexts
+
+![Python Compatibility](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue.svg) [![PyPi Version](https://img.shields.io/pypi/v/django-admin-contexts.svg)](https://pypi.python.org/pypi/django-admin-contexts) ![CI badge](https://github.com/matagus/django-admin-contexts/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/matagus/django-admin-contexts/graph/badge.svg?token=a64SxEDQk0)](https://codecov.io/gh/matagus/django-admin-contexts) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+Display only a set of apps and models in the Django Admin homepage, based on the chosen context. This is useful when
+you have a lot of apps and models and you want to focus on a specific set of them.
+
+![Demo: selecting a context to dsiplay only a subset of models](https://raw.githubusercontent.com/matagus/django-admin-contexts/main/screenshots/demo.gif)
+
+
+Installation
+============
+
+Via `pip` command:
+
+```bash
+pip install django-admin-contexts
+```
+
+...or you can clone the repo and install it using `pip` too:
+
+```bash
+git clone git://github.com/matagus/django-admin-contexts.git
+cd django-admin-contexts
+pip install -e .
+```
+
+then add `django_admin_contexts` to your `settings.py` **before** `django.contrib.admin`:
+
+```python
+INSTALLED_APPS = (
+    # ...
+    "django_admin_contexts",
+    # ...
+    "django.contrib.admin",
+    # ...
+)
+```
+
+then run the migrations:
+
+```bash
+python manage.py migrate
+```
+
+Usage
+=====
+
+Browse to the Django Admin and create some contexts in the "Django Admin Contexts" section, associating them with one
+or more models.
+
+Then, you can see the contexts in the Django Admin homepage.
+
+
+Contributing
+============
+
+Contributions are welcome! ❤️
+
+Please read [Contributing.md](CONTRIBUTING.md) for detailed instructions on how to help.
+
+Running Tests
+-------------
+
+`hatch run test:test` will run the tests in every Python + Django versions combination.
+
+`hatch run test.py3.12-5.0:test will run them for python 3.12 and Django 5.0. Please see possible combinations using
+`hatch env show` ("test" matrix).
+
+
+License
+=======
+
+`django-admin-contexts` is released under an BSD License - see the `LICENSE` file for more information.
+
+
+Acknowledgements
+================
+
+Develop & built using [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

django_admin_contexts-0.2.0/README.md

@@ -0,0 +1,80 @@
+# django-admin-contexts
+
+![Python Compatibility](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue.svg) [![PyPi Version](https://img.shields.io/pypi/v/django-admin-contexts.svg)](https://pypi.python.org/pypi/django-admin-contexts) ![CI badge](https://github.com/matagus/django-admin-contexts/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/matagus/django-admin-contexts/graph/badge.svg?token=a64SxEDQk0)](https://codecov.io/gh/matagus/django-admin-contexts) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+Display only a set of apps and models in the Django Admin homepage, based on the chosen context. This is useful when
+you have a lot of apps and models and you want to focus on a specific set of them.
+
+![Demo: selecting a context to dsiplay only a subset of models](https://raw.githubusercontent.com/matagus/django-admin-contexts/main/screenshots/demo.gif)
+
+
+Installation
+============
+
+Via `pip` command:
+
+```bash
+pip install django-admin-contexts
+```
+
+...or you can clone the repo and install it using `pip` too:
+
+```bash
+git clone git://github.com/matagus/django-admin-contexts.git
+cd django-admin-contexts
+pip install -e .
+```
+
+then add `django_admin_contexts` to your `settings.py` **before** `django.contrib.admin`:
+
+```python
+INSTALLED_APPS = (
+    # ...
+    "django_admin_contexts",
+    # ...
+    "django.contrib.admin",
+    # ...
+)
+```
+
+then run the migrations:
+
+```bash
+python manage.py migrate
+```
+
+Usage
+=====
+
+Browse to the Django Admin and create some contexts in the "Django Admin Contexts" section, associating them with one
+or more models.
+
+Then, you can see the contexts in the Django Admin homepage.
+
+
+Contributing
+============
+
+Contributions are welcome! ❤️
+
+Please read [Contributing.md](CONTRIBUTING.md) for detailed instructions on how to help.
+
+Running Tests
+-------------
+
+`hatch run test:test` will run the tests in every Python + Django versions combination.
+
+`hatch run test.py3.12-5.0:test will run them for python 3.12 and Django 5.0. Please see possible combinations using
+`hatch env show` ("test" matrix).
+
+
+License
+=======
+
+`django-admin-contexts` is released under an BSD License - see the `LICENSE` file for more information.
+
+
+Acknowledgements
+================
+
+Develop & built using [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

django_admin_contexts-0.2.0/django_admin_contexts/__about__.py

@@ -0,0 +1 @@
+version = "0.2.0"

django_admin_contexts-0.2.0/django_admin_contexts/admin.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
+
+from django_admin_contexts.models import AdminContext
+
+
+@admin.register(AdminContext)
+class AdminContextAdmin(admin.ModelAdmin):
+    list_display = ["name", "slug", "description", "created_at", "updated_at"]
+    prepopulated_fields = {"slug": ("name",)}
+
+    class Meta:
+        verbose_name = _("Admin Context")
+        verbose_name_plural = _("Admin Contexts")

django_admin_contexts-0.2.0/django_admin_contexts/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DjangoAdminContextsConfig(AppConfig):
+    name = "django_admin_contexts"
+    default = True

django_admin_contexts-0.2.0/django_admin_contexts/forms.py

@@ -0,0 +1,12 @@
+from django import forms
+
+from django_admin_contexts.models import AdminContext
+
+
+class AdminContextForm(forms.Form):
+    context = forms.ModelChoiceField(
+        queryset=AdminContext.objects.all(),
+        required=False,
+        empty_label="Any",
+        widget=forms.Select(attrs={"onchange": "this.form.submit()"}),
+    )

django_admin_contexts-0.2.0/django_admin_contexts/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.0.3 on 2024-03-30 08:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="AdminContext",
+            fields=[
+                ("slug", models.CharField(max_length=100, primary_key=True, serialize=False)),
+                ("name", models.CharField(max_length=100)),
+                ("description", models.TextField(blank=True, null=True)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("models", models.ManyToManyField(to="contenttypes.contenttype")),
+            ],
+            options={
+                "indexes": [models.Index(fields=["name"], name="django_admi_name_ba627c_idx")],
+            },
+        ),
+    ]

django_admin_contexts-0.2.0/django_admin_contexts/models.py

@@ -0,0 +1,19 @@
+from django.db import models
+from django.contrib.contenttypes.models import ContentType
+
+
+class AdminContext(models.Model):
+    slug = models.CharField(max_length=100, primary_key=True)
+    name = models.CharField(max_length=100)
+    description = models.TextField(blank=True, null=True)
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    models = models.ManyToManyField(ContentType)
+
+    class Meta:
+        indexes = [models.Index(fields=["name"])]
+
+    def __str__(self):
+        return self.name

django_admin_contexts-0.2.0/django_admin_contexts/templates/admin/app_list.html

@@ -0,0 +1,51 @@
+{% load i18n django_admin_contexts_tags %}
+
+{% if app_list %}
+  {% get_contexts_form as contexts_form %}
+  {% if contexts_form %}
+    <form action="{% url 'admin:index' %}" method="get">
+      {{ contexts_form }}
+    </form>
+  {% endif %}
+  {% filter_by_context app_list as filtered_app_list %}
+  {% for app in filtered_app_list %}
+    <div class="app-{{ app.app_label }} module{% if app.app_url in request.path|urlencode %} current-app{% endif %}">
+      <table>
+        <caption>
+          <a href="{{ app.app_url }}" class="section" title="{% blocktranslate with name=app.name %}Models in the {{ name }} application{% endblocktranslate %}">{{ app.name }}</a>
+        </caption>
+        {% for model in app.models %}
+          {% with model_name=model.object_name|lower %}
+            <tr class="model-{{ model_name }}{% if model.admin_url in request.path|urlencode %} current-model{% endif %}">
+              <th scope="row" id="{{ app.app_label }}-{{ model_name }}">
+                {% if model.admin_url %}
+                  <a href="{{ model.admin_url }}"{% if model.admin_url in request.path|urlencode %} aria-current="page"{% endif %}>{{ model.name }}</a>
+                {% else %}
+                  {{ model.name }}
+                {% endif %}
+              </th>
+
+              {% if model.add_url %}
+                <td><a href="{{ model.add_url }}" class="addlink" aria-describedby="{{ app.app_label }}-{{ model_name }}">{% translate 'Add' %}</a></td>
+              {% else %}
+                <td></td>
+              {% endif %}
+
+              {% if model.admin_url and show_changelinks %}
+                {% if model.view_only %}
+                  <td><a href="{{ model.admin_url }}" class="viewlink" aria-describedby="{{ app.app_label }}-{{ model_name }}">{% translate 'View' %}</a></td>
+                {% else %}
+                  <td><a href="{{ model.admin_url }}" class="changelink" aria-describedby="{{ app.app_label }}-{{ model_name }}">{% translate 'Change' %}</a></td>
+                {% endif %}
+              {% elif show_changelinks %}
+                <td></td>
+              {% endif %}
+            </tr>
+          {% endwith %}
+        {% endfor %}
+      </table>
+    </div>
+  {% endfor %}
+{% else %}
+  <p>{% translate 'You don’t have permission to view or edit anything.' %}</p>
+{% endif %}

django_admin_contexts-0.2.0/django_admin_contexts/templatetags/django_admin_contexts_tags.py

@@ -0,0 +1,54 @@
+from collections import defaultdict
+
+from django import template
+from django.urls import reverse
+
+from django_admin_contexts.forms import AdminContextForm
+
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def get_contexts_form(context):
+    request = context["request"]
+
+    # Only show the form on the admin index page
+    if request.path == reverse("admin:index"):
+        return AdminContextForm(request.GET)
+
+    return None
+
+
+@register.simple_tag(takes_context=True)
+def filter_by_context(context, app_list):
+    context_app_dict = defaultdict(list)
+    request = context["request"]
+    form = AdminContextForm(request.GET)
+    if form.is_valid():
+        context = form.cleaned_data.get("context")
+
+        if context is None:
+            return app_list
+
+        for context_type in context.models.all():
+            context_app_dict[context_type.app_label].append(context_type.model)
+
+    filtered_app_list = []
+
+    for app in app_list:
+        if app["app_label"] in context_app_dict:
+            app_with_filterred_models = {
+                "app_label": app["app_label"],
+                "app_url": app["app_url"],
+                "name": app["name"],
+                "has_module_perms": app["has_module_perms"],
+                "models": [
+                    model
+                    for model in app["models"]
+                    if model["object_name"].lower() in context_app_dict[app["app_label"]]
+                ],
+            }
+            filtered_app_list.append(app_with_filterred_models)
+
+    return filtered_app_list

django_admin_contexts-0.2.0/pyproject.toml

@@ -0,0 +1,116 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "django-admin-contexts"
+dynamic = ["version"]
+description = "Contexts for Django Admin homepage"
+readme = "README.md"
+license = "BSD-3-clause"
+authors = [
+    { name = "Matias Agustin Mendez", email = "matagus@gmail.com" },
+]
+keywords = []
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 4.0",
+    "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Software Development :: Libraries",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "Django>=4.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ipython",
+    "django-extensions",
+    "Werkzeug",
+    "django-debug-toolbar",
+]
+
+[project.urls]
+Homepage = "https://github.com/matagus/django-admin-contexts"
+Issues = "https://.github.com/matagus/django-admin-contexts/issues"
+Repository = "https://github.com/matagus/django-admin-contexts"
+Changelog = "https://githib.com/matagus/django-admin-contexts/releases"
+Pypi = "https://pypi.org/project/django-admin-contexts"
+
+[tool.hatch.version]
+path = "django_admin_contexts/__about__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "django_admin_contexts/",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+    "django_admin_contexts/",
+]
+
+[tool.hatch.envs.default]
+features = ["dev"]
+
+[tool.hatch.envs.project]
+template = "default"
+extra-dependencies = [
+  "django-taggit", "django-waffle", "django-guardian", "django-organizations", "django-helpdesk",
+  "django-user-accounts", "pinax", "django-payments", "easy-thumbnails", "django-activity-stream",
+]
+
+[tool.hatch.envs.project.scripts]
+runserver = "python example_project/manage.py runserver_plus {args}"
+shell = "python example_project/manage.py shell_plus {args}"
+migrate = "python example_project/manage.py migrate {args}"
+makemigrations = "python example_project/manage.py makemigrations {args}"
+createsuperuser = "python example_project/manage.py createsuperuser {args}"
+
+# Test environment
+[[tool.hatch.envs.test.matrix]]
+django = ["4.0"]
+python = ["3.9", "3.10"]
+
+[[tool.hatch.envs.test.matrix]]
+django = ["4.1"]
+python = ["3.9", "3.10", "3.11"]
+
+[[tool.hatch.envs.test.matrix]]
+django = ["4.2"]
+python = ["3.9", "3.10", "3.11", "3.12"]
+
+[[tool.hatch.envs.test.matrix]]
+django = ["5.0"]
+python = ["3.10", "3.11", "3.12"]
+
+[tool.hatch.envs.test]
+dependencies = ["coverage[toml]", "django~={matrix:django}.0"]
+
+[tool.hatch.envs.test.scripts]
+test = "python -m django test --settings tests.settings"
+test-cov = "coverage run -m django test --settings tests.settings"
+cov-report = ["coverage json", "coverage report"]
+cov = ["test-cov", "cov-report"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.black]
+line-length = 120