Skip to main content

This module has core functionality for ovp users, such as authentication, user management password recovery and registration

Project description

https://img.shields.io/codeship/b8242540-6d59-0134-3942-5649fa39e129/master.svg?style=flat-square https://img.shields.io/codecov/c/github/OpenVolunteeringPlatform/django-ovp-users.svg?style=flat-square https://img.shields.io/pypi/v/ovp-users.svg?style=flat-square

This module implements core user functionality.

Getting Started

Installing

  1. Install django-ovp-users:

    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, take a look at django-git-submodules.

Testing

To test this module

python ovp_users/tests/runtests.py

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GNU GPLv3 License see the LICENSE.md file for details

Project details


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-1.1.8.tar.gz (67.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page