This module has core functionality for ovp users, such as authentication, user management password recovery and registration
Project description
=====
OVP Users
=====
This module implements core user functionality.
Getting Started
---------------
Installing
""""""""""""""
1. Install django-git-submodules::
pip install ovp-users
2. Add it to `INSTALLED_APPS` on `settings.py`
3. Add `rest_framework_jwt` to `INSTALLED_APPS`
4. Set up REST Framework Authentication::
# Rest framework
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.BasicAuthentication',
'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
)
}
::
# User models
AUTH_USER_MODEL = 'ovp_users.User'
Forking
""""""""""""""
If you have your own OVP installation and want to fork this module
to implement custom features while still merging changes from upstream,
read Forking section on the wiki.
Testing
---------------
To test this module
::
python run_tests.py
Contributing
---------------
Please read `CONTRIBUTING.md <https://github.com/OpenVolunteeringPlatform/django-ovp-users/blob/master/CONTRIBUTING.md>`_ for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
---------------
We use `SemVer <http://semver.org/>`_ for versioning. For the versions available, see the `tags on this repository <https://github.com/OpenVolunteeringPlatform/django-ovp-users/tags>`_.
License
---------------
This project is licensed under the GNU GPLv3 License see the `LICENSE.md <https://github.com/OpenVolunteeringPlatform/django-ovp-users/blob/master/LICENSE.md>`_ file for details
OVP Users
=====
This module implements core user functionality.
Getting Started
---------------
Installing
""""""""""""""
1. Install django-git-submodules::
pip install ovp-users
2. Add it to `INSTALLED_APPS` on `settings.py`
3. Add `rest_framework_jwt` to `INSTALLED_APPS`
4. Set up REST Framework Authentication::
# Rest framework
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.BasicAuthentication',
'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
)
}
::
# User models
AUTH_USER_MODEL = 'ovp_users.User'
Forking
""""""""""""""
If you have your own OVP installation and want to fork this module
to implement custom features while still merging changes from upstream,
read Forking section on the wiki.
Testing
---------------
To test this module
::
python run_tests.py
Contributing
---------------
Please read `CONTRIBUTING.md <https://github.com/OpenVolunteeringPlatform/django-ovp-users/blob/master/CONTRIBUTING.md>`_ for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
---------------
We use `SemVer <http://semver.org/>`_ for versioning. For the versions available, see the `tags on this repository <https://github.com/OpenVolunteeringPlatform/django-ovp-users/tags>`_.
License
---------------
This project is licensed under the GNU GPLv3 License see the `LICENSE.md <https://github.com/OpenVolunteeringPlatform/django-ovp-users/blob/master/LICENSE.md>`_ file for 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
ovp-users-0.1.2.tar.gz
(27.2 kB
view hashes)
