Metadata-Version: 1.1
Name: ovp-users
Version: 1.0.6
Summary: This module has core functionality for ovp users, such as authentication, user management password recovery and registration
Home-page: https://github.com/OpenVolunteeringPlatform/ovp-users
Author: Atados
Author-email: arroyo@atados.com.br
License: AGPL
Download-URL: https://github.com/OpenVolunteeringPlatform/ovp-users/tarball/1.0.6
Description: ==========
        OVP Users
        ==========
        
        .. image:: https://app.codeship.com/projects/b8242540-6d59-0134-3942-5649fa39e129/status?branch=master
        .. image:: https://codecov.io/gh/OpenVolunteeringPlatform/django-ovp-users/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/OpenVolunteeringPlatform/django-ovp-users
        .. image:: https://badge.fury.io/py/ovp-users.svg
            :target: https://badge.fury.io/py/ovp-users
        
        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 <https://github.com/leonardoarroyo/django-git-submodules>`_.
        
        Testing
        ---------------
        To test this module
        
        ::
        
          python ovp_users/tests/runtests.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
        
Platform: UNKNOWN
