django-admin-interface

v0.29.1

django's default admin interface with superpowers - customizable themes, popup windows replaced by modals and many other features. For more information about how to use this package see README

Latest version published 13 days ago

License: MIT

PyPI

GitHub

Package Health Score

77 / 100

security
Security review needed
popularity
Popular
maintenance
Healthy
community
Active

Popularity

Popular

GitHub Stars: 1.82K
Forks: 180
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package django-admin-interface, we found that it has been starred 1,822 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 23, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 12
Open PR: 4
Last Release: 13 days ago
Last Commit: 13 days ago

Further analysis of the maintenance status of django-admin-interface based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that django-admin-interface demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 40
Funding: Yes

With more than 10 contributors for the django-admin-interface repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.10.*, ==3.11.*, ==3.12.*, ==3.13.*

Age: 9 years
Latest Release: 13 days ago
Dependencies: 0 Direct
Versions: 120
Maintainers: 1
Wheels: OS Independent

Readme

django-admin-interface

django-admin-interface is a modern responsive flat admin interface customizable by the admin itself.

django-admin-interface-preview

Features

Beautiful default django-theme
Themes management and customization (you can customize admin title, logo and colors)
Responsive
Related modal (instead of the old popup window)
Environment name/marker
Language chooser
Foldable apps (accordions in the navigation bar)
Collapsible fieldsets can have their initial state expanded instead of collapsed
NEW Collapsible inlines
NEW Tabbed fieldsets and inlines
NEW List filter removal links
NEW List filter highlight selected options
List filter dropdown
List filter sticky
Form controls sticky (pagination and save/delete buttons)
Compatibility / style optimizations for:
- django-ckeditor
- django-dynamic-raw-id
- django-json-widget
- django-modeltranslation
- django-rangefilter
- django-streamfield
- django-tabbed-admin
- sorl-thumbnail
Translated in many languages: de, es, fa, fr, it, pl, pt_BR, ru, tr

Installation

Run pip install django-admin-interface
Add admin_interface and colorfield to settings.INSTALLED_APPS before django.contrib.admin

INSTALLED_APPS = (
    #...
    "admin_interface",
    "colorfield",
    #...
    "django.contrib.admin",
    #...
)

X_FRAME_OPTIONS = "SAMEORIGIN"
SILENCED_SYSTEM_CHECKS = ["security.W019"]

Run python manage.py migrate
Run python manage.py collectstatic --clear
Restart your application server

[!WARNING] if you want use modals instead of popup windows, ensure to add X_FRAME_OPTIONS = "SAMEORIGIN" setting.

Optional features

To make a fieldset start expanded with a Hide button to collapse, add the class "expanded" to its classes:

class MyModelAdmin(admin.ModelAdmin):
    # ...
    fieldsets = [
        ("Section title", {
            "classes": ("collapse", "expanded"),
            "fields": (...),
        }),
    ]
    # ...

Optional themes

This package ships with optional themes as fixtures, they can be installed using the loaddata admin command. Optional themes are activated on installation.

Django theme (default):

Run python manage.py loaddata admin_interface_theme_django.json

Bootstrap theme:

Run python manage.py loaddata admin_interface_theme_bootstrap.json

Foundation theme:

Run python manage.py loaddata admin_interface_theme_foundation.json

U.S. Web Design Standards theme:

Run python manage.py loaddata admin_interface_theme_uswds.json

Add more themes

You can add a theme you've created through the admin to this repository by sending us a PR. Here are the steps to follow to add:

Export your exact theme as fixture using the dumpdata admin command: python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N
Copy the generated json file into the fixtures folder (making sure its name starts with admin_interface_theme_ to avoid clashes with fixtures that might be provided by other third party apps).
Remove the pk from the fixture and make sure the active field is set to true (in this way a theme is automatically activated when installed).
Edit the section above to document your theme.

Add theme support to third-party libraries

You can add theme support to existing third-party libraries using the following CSS variables:

Header

--admin-interface-header-background-color
--admin-interface-header-text-color
--admin-interface-header-link-color
--admin-interface-header-link_hover-color
--admin-interface-title-color
--admin-interface-env-color

Logo

--admin-interface-logo-color
--admin-interface-logo-default-background-image
--admin-interface-logo-max-width
--admin-interface-logo-max-height

Buttons

--admin-interface-save-button-background-color
--admin-interface-save-button-background-hover-color
--admin-interface-save-button-text-color
--admin-interface-delete-button-background-color
--admin-interface-delete-button-background-hover-color
--admin-interface-delete-button-text-color

Related Modal

--admin-interface-related-modal-background-color
--admin-interface-related-modal-background-opacity
--admin-interface-related-modal-border-radius
--admin-interface-related-modal-close-button-display

Screenshots

Admin login

Admin dashboard

Admin themes management

Admin theme customization

django-admin-interface_theme_customization

Localization

At the moment, this package has been translated into the following languages: de, es, fa, fr, it, pl, pt_BR, tr.

Translate into another language

Run python -m django makemessages --ignore ".tox" --ignore "venv" --add-location "file" --extension "html,py" --locale "it" (example for Italian localization)
Update translations in admin_interface/locale/it/LC_MESSAGES/django.po
Run python -m django compilemessages --ignore ".tox" --ignore "venv"

Update translations

If you do some changes to the project, remember to update translations, because if the translations files are not up-to-date, the lint step in the CI will fail:

Run tox -e translations

Caching

This package uses caching to improve theme load time and overall performance. You can customise the app caching options using settings.CACHES["admin_interface"] setting, otherwise the "default" cache will be used:

CACHES = {
    # ...
    "admin_interface": {
        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
        "TIMEOUT": 60 * 5,
    },
    # ...
}

[!WARNING] There is a known compatibility issue when using this package with django-redis, more specifically, using the JSONSerializer the following error is raised: TypeError: Object of type Theme is not JSON serializable, to mitigate this problem, simply use a specific cache for this app that does not use any json serializer.

FAQ

Custom `base-site.html`

I already have a custom base_site.html, how can I make it work?

You can use django-apptemplates, then add {% extends "admin_interface:admin/base_site.html" %} to your base_site.html

Custom `LocaleMiddleware` warning

I'm using a django.middleware.locale.LocaleMiddleware subclass, but I see an unnecessary warning for missing django.middleware.locale.LocaleMiddleware, what can I do?

You can simply ignore the warning (this has been discussed here)

import warnings

warnings.filterwarnings("ignore", module="admin_interface.templatetags.admin_interface_tags")

Language Chooser not showing

I have enabled the Language Chooser, but it is not visible in the admin, what should I do?

You must configure multilanguage settings and urls correctly:

LANGUAGES = (
    ("en", _("English")),
    ("it", _("Italiano")),
    ("fr", _("Français")),
    # more than one language is expected here
)
LANGUAGE_CODE = "en"
USE_I18N = True
MIDDLEWARE = [
    # ...
    "django.middleware.locale.LocaleMiddleware",
    # ...
]

from django.conf.urls.i18n import i18n_patterns
from django.contrib import admin
from django.urls import include, path

# ...

urlpatterns = [
    path("i18n/", include("django.conf.urls.i18n")),
]
urlpatterns += i18n_patterns(path("admin/", admin.site.urls))

Open any url in modal window

I have an application with some cross-links in the admin and I would like to open them in modal windows instead of same/new window, how can I do?

You just need to add _popup=1 query-string parameter to the urls:

url = reverse(f"admin:myapp_mymodel_change", args=[mymodel_instance.pk])
url = f"{url}?_popup=1"

Testing

# clone repository
git clone https://github.com/fabiocaccamo/django-admin-interface.git && cd django-admin-interface

# 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"

Contributing

Contributions are always welcome, please follow these steps for submitting good quality PRs:

❗ Open an issue, please don't submit any PR that doesn't refer to an existing issue.
💻 Work on changes, changes should preferably be covered by tests to avoid regressions in the future.
🌐 Update the translations files.
🧪 Run tests ensuring that there are no errors.
📥 Submit a pull-request and mark it as "Ready for review" only if it passes the CI.

License

Released under MIT License.

Supporting

⭐ Star this project on GitHub
:octocat: Follow me on GitHub
💙 Follow me on Twitter
💰 Sponsor me on Github

FAQs

What is django-admin-interface?

django's default admin interface with superpowers - customizable themes, popup windows replaced by modals and many othe... Visit Snyk Advisor to see a full health score report for django-admin-interface, including popularity, security, maintenance & community analysis.

Is django-admin-interface popular?

The python package django-admin-interface receives a total of 45,364 weekly downloads. As such, django-admin-interface popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is django-admin-interface well maintained?

We found that django-admin-interface demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is django-admin-interface safe to use?

While scanning the latest version of django-admin-interface, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 5 November-2024, at 04:06 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

django-admin-interface

Features

Installation

Optional features

Optional themes

Django theme (default):

Bootstrap theme:

Foundation theme:

U.S. Web Design Standards theme:

Add more themes

Add theme support to third-party libraries

Header

Logo

Modules / Links

Buttons

Related Modal

Screenshots

Admin login

Admin dashboard

Admin themes management

Admin theme customization

Localization

Translate into another language

Update translations

Caching

FAQ

Custom base-site.html

Custom LocaleMiddleware warning

Language Chooser not showing

Open any url in modal window

Testing

Contributing

License

Supporting

See also

FAQs

What is django-admin-interface?

Is django-admin-interface popular?

Is django-admin-interface well maintained?

Is django-admin-interface safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Custom `base-site.html`

Custom `LocaleMiddleware` warning