1.. _upgrade: 2 3Upgrade guide 4============= 5 6The |version| release of |project| is not compatible with the legacy 7django-registration (previously maintained by James Bennett). Major backwards 8incompatible changes will be recorded here, but for a full list of changes 9between versions you should refer to the `CHANGELOG 10<https://github.com/macropin/django-registration/blob/master/CHANGELOG>`_. 11 12Django version requirement 13-------------------------- 14 15As of |version|, |project| requires Django 1.11 or newer; 16older Django releases may work, but are officially unsupported. Additionally, 17|project| officially supports Python 2.7, 3.5, 3.6, 3.7 and 3.8. 18 19 20Backwards-incompatible changes 21------------------------------ 22 23Version 2.8 24``````````` 25 26- None 27 28Version 2.7 29``````````` 30 31- None 32 33Version 2.6 34``````````` 35 36- None 37 38Version 2.5 39``````````` 40 41- None 42 43Version 2.4 44``````````` 45 46- None 47 48Version 2.3 49``````````` 50 51- None 52 53 54Version 2.2 55``````````` 56 57- None 58 59 60Version 2.1 61``````````` 62 63- None 64 65 66Version 2.0 67``````````` 68 69- Removed support for Django < 1.11. 70- Removed `registration/urls.py` in favor of 71 `registration/backends/default/urls.py` 72 73 74Version 1.9 75``````````` 76- Change of return signature of 77 ``RegistrationProfileManager.activate_user``. A tuple containing the 78 User instance and a boolean of whether or not said user was activated 79 is now returned. 80 81 82Version 1.8 83``````````` 84 85- None 86 87Version 1.7 88``````````` 89 90- None 91 92Version 1.6 93``````````` 94 95- None 96 97Version 1.5 98``````````` 99 100- Support for Django 1.7 is removed, and Django 1.8 or newer is required. 101- Change signature of ``RegistrationProfileManager.activate_user``. 102 ``site`` is now a required positional argument. 103 See `#244 <https://github.com/macropin/django-registration/pull/244>`_. 104 105Version 1.4 106``````````` 107 108- Remove unnecessary `_RequestPassingFormView`. 109 See `#56 <https://github.com/macropin/django-registration/pull/56>`_. Please 110 ensure that you update any subclassed views to reference ``self.request`` 111 instead of accepting ``request`` as an argument. 112 113Version 1.3 114``````````` 115- Django 1.7 or newer is required. Please ensure you upgrade your Django 116 version before upgrading. 117 118Version 1.2 119``````````` 120- **Native migration support breaks South compatibility**: An initial native 121 migration for Django > 1.7 has been provided. South users will need to 122 configure a null migration with (`SOUTH_MIGRATION_MODULES`) in 123 `settings.py` as shown below: 124 125 :: 126 127 SOUTH_MIGRATION_MODULES = { 128 'registration': 'registration.south_migrations', 129 130- **register method in RegistrationView has different parameters**: The 131 parameters of the`register` method in RegistrationView have changed. 132 133Version 1.1 134``````````` 135 136- **base.html template required**: A `base.html` template is now assumed to 137 exist. Please ensure that your project provides one for |project| to inherit 138 from. 139- **HTML email templates**: |project| now uses HTML email templates. If you 140 previously customized text email templates, you need to do the same with 141 the new HTML templates. 142