Migration Guide¶
Migrating to 1.0¶
The stable release has introduced a number of backward incompatible changes and purpose of this guide is to allow developer to quickly adapt a given project.
Removal of UserEmailFactoryBase and its subclasses¶
As mentioned in Emails page
since 1.0 email support has been removed from Djoser and it is advised to
use django-templated-mail
for use cases which were previously handled by djoser email support.
You can find out more about it in the
project documentation.
Keep in mind that DOMAIN and SITE_NAME settings have also been moved to
django-templated-mail as described in
settings page.
Base URLs are no longer included with other URLs¶
Previously djoser.urls.base were bundled with djoser.urls.authtoken,
however in some cases developer might not need them and therefore if
base URLs are needed it is now necessary to explicitly include them, e.g.:
urlpatterns = [
(...),
url(r'^auth/', include('djoser.urls')),
url(r'^auth/', include('djoser.urls.authtoken')),
]
Dropped support for Django < 1.10¶
Support for Django 1.8 and 1.9 has been dropped in Django REST Framework 3.7 and hence there was no reason to keep it in djoser. It is recommended to upgrade to Django 1.11, since 1.10 will EOL in December 2017. Django Deprecation Timeline and Django Release Notes are very helpful in the process.
Some View class names and URLs has been updated¶
Also please note that for sake of consistency all URLs now end with a trailing slash.
View class names:
RegistrationViewhas been renamed toUserCreateViewLoginViewhas been renamed toTokenCreateViewLogoutViewhas been renamed toTokenDestroyView
Base URLs:
register/has been renamed tousers/create/registerURL name has been renamed touser-createactivate/has been renamed tousers/activate/activateURL name has been renamed touser-activate
Token Based Authentication URLs:
login/has been renamed totoken/create/loginURL name has been renamed totoken-createlogout/has been renamed totoken/destroy/logoutURL name has been renamed totoken-destroy