Metadata-Version: 2.1
Name: dj-rest-auth
Version: 2.2.8
Summary: Authentication and Registration in Django Rest Framework
Home-page: http://github.com/iMerica/dj-rest-auth
Author: iMerica
Author-email: imichael@pm.me
License: MIT
Description: # Dj-Rest-Auth
        [![<iMerica>](https://circleci.com/gh/iMerica/dj-rest-auth.svg?style=svg)](https://app.circleci.com/pipelines/github/iMerica/dj-rest-auth)
        
        
        Drop-in API endpoints for handling authentication securely in Django Rest Framework. Works especially well 
        with SPAs (e.g React, Vue, Angular), and Mobile applications. 
        
        ## Requirements
        - Django 2, 3 or 4 (See Unit Test Coverage in CI)
        - Python 3
        
        ## Quick Setup
        
        Install package
        
            pip install dj-rest-auth
            
        Add `dj_rest_auth` app to INSTALLED_APPS in your django settings.py:
        
        ```python
        INSTALLED_APPS = (
            ...,
            'rest_framework',
            'rest_framework.authtoken',
            ...,
            'dj_rest_auth'
        )
        ```
            
        Add URL patterns
        
        ```python
        urlpatterns = [
            path('dj-rest-auth/', include('dj_rest_auth.urls')),
        ]
        ```
            
        
        (Optional) Use Http-Only cookies
        
        ```python
        REST_USE_JWT = True
        JWT_AUTH_COOKIE = 'jwt-auth'
        ```
        
        ### Testing
        
        Install required modules with `pip install -r  dj_rest_auth/tests/requirements.pip`
        
        To run the tests within a virtualenv, run `python runtests.py` from the repository directory.
        The easiest way to run test coverage is with [`coverage`](https://pypi.org/project/coverage/),
        which runs the tests against all supported Django installs. To run the test coverage 
        within a virtualenv, run `coverage run ./runtests.py` from the repository directory then run `coverage report`.
        
        #### Tox
        
        Testing may also be done using [`tox`](https://pypi.org/project/tox/), which
        will run the tests against all supported combinations of python and django.
        
        Install tox, either globally or within a virtualenv, and then simply run `tox`
        from the repository directory. As there are many combinations, you may run them
        in [`parallel`](https://tox.readthedocs.io/en/latest/config.html#cmdoption-tox-p)
        using `tox --parallel`.
        
        The `tox.ini` includes an environment for testing code [`coverage`](https://pypi.org/project/coverage/)
        and you can run it and view this report with `tox -e coverage`.
        
        Linting may also be performed via [`flake8`](https://pypi.org/project/flake8/)
        by running `tox -e flake8`.
        
        ### Documentation
        
        View the full documentation here: https://dj-rest-auth.readthedocs.io/en/latest/index.html
        
        
        ### Acknowledgements
        
        This project began as a fork of `django-rest-auth`. Big thanks to everyone who contributed to that repo!
        
        #### A note on Django AllAuth from @iMerica
        
        This project has an optional and very narrow support for Django-AllAuth. As maintainer I have no intererest in making this package support every and all use case in Django All Auth. I would rather focus on improving the quality of the base funtionality or focus on OIDC support instead. Pull requests that extend or add more support for Django AllAuth will most likely be declined. Do you disagreee? Feel free to fork this repo!
Keywords: django rest auth registration rest-framework django-registration api
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: with_social
