# Django Rest Password Reset
This django app provides a password reset strategy for django rest framework, where users can request password
reset tokens via their registered e-mail address.
## How to use
Django settings file:
```python
INSTALLED_APPS = (
...
'django.contrib.auth',
...
'rest_framework',
...
'django_rest_passwordreset',
...
)
```
Django url settings:
```python
from django.conf.urls import url, include
urlpatterns = [
...
url(r'^api/password_reset/', include('django_rest_passwordreset.urls', namespace='password_reset')),
...
]
```
The following endpoints are provided:
* `reset_password` - request a reset password token by using the ``email`` parameter
* `reset_password/confirm` - using a valid ``token``, the users password is set to the provided ``password``
## Signals
* ``reset_password_token_created(reset_password_token)`` Fired when a reset password token is generated
* ``pre_password_reset(user)`` - fired just before a password is being reset
* ``post_password_reset(user)`` - fired after a password has been reset
## Tests
See folder [tests/](tests/). Basically, all endpoints are covered with multiple
unit tests.
Use this code snippet to run tests:
```bash
pip install -r requirements_test.txt
python setup.py install
cd tests
python manage.py test
```
This django app provides a password reset strategy for django rest framework, where users can request password
reset tokens via their registered e-mail address.
## How to use
Django settings file:
```python
INSTALLED_APPS = (
...
'django.contrib.auth',
...
'rest_framework',
...
'django_rest_passwordreset',
...
)
```
Django url settings:
```python
from django.conf.urls import url, include
urlpatterns = [
...
url(r'^api/password_reset/', include('django_rest_passwordreset.urls', namespace='password_reset')),
...
]
```
The following endpoints are provided:
* `reset_password` - request a reset password token by using the ``email`` parameter
* `reset_password/confirm` - using a valid ``token``, the users password is set to the provided ``password``
## Signals
* ``reset_password_token_created(reset_password_token)`` Fired when a reset password token is generated
* ``pre_password_reset(user)`` - fired just before a password is being reset
* ``post_password_reset(user)`` - fired after a password has been reset
## Tests
See folder [tests/](tests/). Basically, all endpoints are covered with multiple
unit tests.
Use this code snippet to run tests:
```bash
pip install -r requirements_test.txt
python setup.py install
cd tests
python manage.py test
```
Metadata
Release files for django-rest-passwordreset 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-rest-passwordreset-0.9.0.tar.gz | 9.8 kB | Details |
Release files / django-rest-passwordreset-0.9.0.tar.gz
| Download URL | django-rest-passwordreset-0.9.0.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
52ff86fa214a4a0967631067cd32f805c2f6f8fe692c144b8374e327009293e6
|
|
BLAKE2b-256 checksum How to use checksums |
701cc004943e76918c276c964581f93181334a789ec82d149e8315a3a0cdf694
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
