Your project description goes here
Project description
Django Perm Filter
A simple app that can be included in Django projects which hides app specific permissions from any type of User. Easily add entire apps, specific permissions or models and it will take care of the rest. Non-destructive (Does not delete permissions).
For example, typically we have no reason, in any Django project, to expose the following permissions for Users or Groups:
App | Model | Permission |
---|---|---|
admin | log entry | Can view/add/change/delete log entry |
auth | permission | Can view/add/change/delete permission |
contenttypes | content type | Can view/add/change/delete content type |
sessions | session | Can view/add/change/delete session |
Features
- Hide all permissions for an App
- Hide permissions using app and codename (more granular)
- Hide models from the Django Admin
Requirements
Django 3 or 4 Python 3
Quickstart
Install Django Perm Filter::
pip install django-perm-filter
Add it to your INSTALLED_APPS
at the bottom:
INSTALLED_APPS = (
...
'django_perm_filter',
)
In your settings.py
add a entry for PERM_FILTER
:
PERM_FILTER = {
"HIDE_PERMS": [
# Use app name only to hide all app related permissions
"admin",
"contenttypes",
"sessions",
"sites",
# Use app.codename to get more granular
"auth.view_permission",
"auth.add_permission",
"auth.change_permission",
"auth.delete_permission",
],
"UNREGISTER_MODELS": [
"django.contrib.sites.models.Site",
],
}
Optional
By default django_perm_filter
will register a new UserAdmin
and GroupAdmin
which extend django.contrib.auth.admin.UserAdmin
and django.contrib.auth.admin.GroupAdmin
that simply adds permissions filtering. If you would like it to extend your own custom UserAdmin
or GroupAdmin
classes, then set the class path in the PERM_FILTER
settings.
PERM_FILTER = {
...
"USER_ADMIN": "myapp.user.admin.UserAdmin",
"GROUP_ADMIN": "myapp.user.admin.GroupAdmin",
}
Development
Assumes you have pyenv
and make
installed (you should!).
make scratch
Running Tests
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
Development commands
pip install -r requirements_dev.txt
invoke -l
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[0.1.0] - 2022-04-19
- First release on PyPI.
[0.1.1] - 2022-04-19
- Sorry, pushed copy/pasted changelog on first release!
[0.2.0] - 2022-08-11
- Merged
HIDE_APPS
andHIDE_PERMS
to make more clear that we're hiding perms only. - Added ability to extend your own custom
UserAdmin
andGroupAdmin
if need be.
[0.2.1] - 2022-09-19
- Fixed issue if
UserAdmin
orGroupAdmin
were already registered.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_perm_filter-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1778c939f3be53c1b5c2beee3a27334cb4ae02419d7b4e3e120b934bd248199 |
|
MD5 | 523b1caab3e10f90a81752dee7056a86 |
|
BLAKE2b-256 | 86b5b2b3566d799c83a78c307a9c3c5f4ce950089b7a48b8e43ca513abc30477 |