Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfranzel/django-seriously
Opinionated collection of Django and Django REST framework tools that came in handy time and again.
https://github.com/tfranzel/django-seriously
Last synced: 7 days ago
JSON representation
Opinionated collection of Django and Django REST framework tools that came in handy time and again.
- Host: GitHub
- URL: https://github.com/tfranzel/django-seriously
- Owner: tfranzel
- License: bsd-3-clause
- Created: 2021-12-12T11:32:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-19T23:48:20.000Z (about 1 year ago)
- Last Synced: 2024-10-04T12:58:50.477Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 625 KB
- Stars: 24
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
================
django-seriously
================
|build-status| |pypi-version|
... wait what? no seriously, why isn't that part of Django/DRF?
Opinionated collection of `Django`_ and `Django REST framework`_ tools that came in handy time and again.
- ``AdminItemAction``
- Allow triggering context-aware custom admin operations in model list views.
- ``admin_navigation_link``
- Allow navigation from the admin list view to other related models via links.
- ``MinimalUser`` (abstract model)
- Bare minimum user model ready for customization.
- Removes the username and auxiliary fields like ``first_name`` and ``last_name``.
- Allow creating users without a valid password (unusable password)
- Abstract since its highly recommended to subclass the user model anyway.
- ``ValidatedJSONField`` (model field)
- validate the structure of JSON fields with Pydantic models.
- ``TokenAuthentication``
- When OAuth2 adds too much complexity, DRF's TokenAuthentication is too simple, and
`django-rest-knox`_ does not quite fit the permissioning.
- No plain passwords in database (PBKDF2, i.e. hashed and salted)
- Enabled for permission scoping
- Easy (one-time-view) token creation in Django admin
- ``BaseModel`` (abstract model)
- Reusable base model with automatic ``created_at``, ``updated_at`` fields.
- Primary key is a random UUID (``uuid4``).
- Ensure validation logic (``full_clean()``) always runs, not just in a subset of cases.
- ``AppSettings``
- A settings container with defaults and string importing inspired by DRF's ``APISettings``
License
-------
Provided by `T. Franzel `_, `Licensed under 3-Clause BSD `_.
Requirements
------------
- Python >= 3.6
- Django >= 3.0
- Django REST Framework (optional)
Installation
------------
.. code:: bash
$ pip install django-seriously
Demo
----
Showcasing ``AdminItemAction``, ``admin_navigation_link``, ``MinimalUser`` and ``TokenAuthentication``
.. image:: https://github.com/tfranzel/django-seriously/blob/master/docs/demo.gif
Usage
-----
``AdminItemAction``
===================
.. code:: python
# admin.py
from django_seriously.utils.admin import AdminItemAction
class UserAdminAction(AdminItemAction[User]):
model_cls = User
actions = [
("reset_invitation", "Reset Invitation"),
]
@classmethod
def is_actionable(cls, obj: User, action: str) -> bool:
# check whether action should be shown for this item
if action == "reset_invitation":
return is_user_resettable_check(obj) # your code
return False
def perform_action(self, obj: User, action: str) -> Any:
# perform the action on the item
if action == "reset_invitation":
perform_your_resetting(obj) # your code
obj.save()
@admin.register(User)
class UserAdmin(ModelAdmin):
# insert item actions into a list view column
list_display = (..., "admin_actions")
def admin_actions(self, obj: User):
return UserAdminAction.action_markup(obj)
.. code:: python
# urls.py
from django_seriously.utils.admin import AdminItemAction
urlpatterns = [
...
# item actions must precede regular admin endpoints
path("admin/", AdminItemAction.urls()),
path("admin/", admin.site.urls),
]
``admin_navigation_link``
=========================
.. code:: python
# admin.py
from django_seriously.utils.admin import admin_navigation_link
@admin.register(Article)
class ArticleAdmin(ModelAdmin):
# insert item actions into a list view column
list_display = ('id', "name", "author_link")
def author_link(self, obj: Article):
return admin_navigation_link(obj.author, obj.author.name)
``TokenAuthentication``
=======================
.. code:: python
# settings.py
INSTALLED_APPS = [
...
# only required if auth token is not extended by you
'django_seriously.authtoken',
...
]
SERIOUSLY_SETTINGS = {
"AUTH_TOKEN_SCOPES": ["test-scope", "test-scope2"]
}
# views.py
from django_seriously.authtoken.authentication import TokenAuthentication, TokenHasScope
class TestViewSet(viewsets.ModelViewSet):
...
permission_classes = [TokenHasScope]
authentication_classes = [TokenAuthentication]
required_scopes = ['test-scope']
``MinimalUser``
===============
.. code:: python
# models.py
from django_seriously.minimaluser.models import MinimalAbstractUser
from django_seriously.utils.models import BaseModel
# BaseModel is optional but adds useful uuid, created_at, updated_at
class User(BaseModel, MinimalAbstractUser):
pass
# admin.py
from django_seriously.minimaluser.admin import MinimalUserAdmin
@admin.register(User)
class UserAdmin(MinimalUserAdmin):
pass
.. _Django: https://www.djangoproject.com/
.. _Django REST framework: https://www.django-rest-framework.org/
.. _django-rest-knox: https://github.com/James1345/django-rest-knox
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-seriously.svg
:target: https://pypi.python.org/pypi/django-seriously
.. |build-status| image:: https://github.com/tfranzel/django-seriously/actions/workflows/ci.yml/badge.svg
:target: https://github.com/tfranzel/django-seriously/actions/workflows/ci.yml