An extension of django rest framework, providing a password reset strategy
Project description
# 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
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-rest-passwordreset-0.9.0.tar.gz
.
File metadata
- Download URL: django-rest-passwordreset-0.9.0.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
52ff86fa214a4a0967631067cd32f805c2f6f8fe692c144b8374e327009293e6
|
|
MD5 |
88a203534ab76d7bdb2076598e54c5ca
|
|
BLAKE2b-256 |
701cc004943e76918c276c964581f93181334a789ec82d149e8315a3a0cdf694
|