dj-rest-auth


Namedj-rest-auth JSON
Version 5.0.2 PyPI version JSON
download
home_pagehttp://github.com/iMerica/dj-rest-auth
SummaryAuthentication and Registration in Django Rest Framework
upload_time2023-11-15 04:02:07
maintainer
docs_urlNone
authoriMerica
requires_python>=3.6
licenseMIT
keywords django rest auth registration rest-framework django-registration api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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_AUTH = {
    '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 optional and very narrow support for Django-AllAuth. As the maintainer, I have no interest in making this package support all use cases in Django-AllAuth. I would rather focus on improving the quality of the base functionality or focus on OIDC support instead. Pull requests that extend or add more support for Django-AllAuth will most likely be declined. Do you disagree? Feel free to fork this repo!

            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/iMerica/dj-rest-auth",
    "name": "dj-rest-auth",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "django rest auth registration rest-framework django-registration api",
    "author": "iMerica",
    "author_email": "imichael@pm.me",
    "download_url": "https://files.pythonhosted.org/packages/60/0b/344743248e8282e4355661d2e136fffbc80ceeeebe47f9c2c10eaf41dbca/dj-rest-auth-5.0.2.tar.gz",
    "platform": null,
    "description": "# Dj-Rest-Auth\n[![<iMerica>](https://circleci.com/gh/iMerica/dj-rest-auth.svg?style=svg)](https://app.circleci.com/pipelines/github/iMerica/dj-rest-auth)\n\n\nDrop-in API endpoints for handling authentication securely in Django Rest Framework. Works especially well \nwith SPAs (e.g., React, Vue, Angular), and Mobile applications. \n\n## Requirements\n- Django 2, 3, or 4 (See Unit Test Coverage in CI)\n- Python 3\n\n## Quick Setup\n\nInstall package\n\n    pip install dj-rest-auth\n    \nAdd `dj_rest_auth` app to INSTALLED_APPS in your django settings.py:\n\n```python\nINSTALLED_APPS = (\n    ...,\n    'rest_framework',\n    'rest_framework.authtoken',\n    ...,\n    'dj_rest_auth'\n)\n```\n    \nAdd URL patterns\n\n```python\nurlpatterns = [\n    path('dj-rest-auth/', include('dj_rest_auth.urls')),\n]\n```\n    \n\n(Optional) Use Http-Only cookies\n\n```python\nREST_AUTH = {\n    'USE_JWT': True,\n    'JWT_AUTH_COOKIE': 'jwt-auth',\n}\n```\n\n### Testing\n\nInstall required modules with `pip install -r  dj_rest_auth/tests/requirements.pip`\n\nTo run the tests within a virtualenv, run `python runtests.py` from the repository directory.\nThe easiest way to run test coverage is with [`coverage`](https://pypi.org/project/coverage/),\nwhich runs the tests against all supported Django installs. To run the test coverage \nwithin a virtualenv, run `coverage run ./runtests.py` from the repository directory then run `coverage report`.\n\n#### Tox\n\nTesting may also be done using [`tox`](https://pypi.org/project/tox/), which\nwill run the tests against all supported combinations of Python and Django.\n\nInstall tox, either globally or within a virtualenv, and then simply run `tox`\nfrom the repository directory. As there are many combinations, you may run them\nin [`parallel`](https://tox.readthedocs.io/en/latest/config.html#cmdoption-tox-p)\nusing `tox --parallel`.\n\nThe `tox.ini` includes an environment for testing code [`coverage`](https://pypi.org/project/coverage/)\nand you can run it and view this report with `tox -e coverage`.\n\nLinting may also be performed via [`flake8`](https://pypi.org/project/flake8/)\nby running `tox -e flake8`.\n\n### Documentation\n\nView the full documentation here: https://dj-rest-auth.readthedocs.io/en/latest/index.html\n\n\n### Acknowledgements\n\nThis project began as a fork of `django-rest-auth`. Big thanks to everyone who contributed to that repo!\n\n#### A note on Django AllAuth from @iMerica\n\nThis project has optional and very narrow support for Django-AllAuth. As the maintainer, I have no interest in making this package support all use cases in Django-AllAuth. I would rather focus on improving the quality of the base functionality or focus on OIDC support instead. Pull requests that extend or add more support for Django-AllAuth will most likely be declined. Do you disagree? Feel free to fork this repo!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Authentication and Registration in Django Rest Framework",
    "version": "5.0.2",
    "project_urls": {
        "Homepage": "http://github.com/iMerica/dj-rest-auth"
    },
    "split_keywords": [
        "django",
        "rest",
        "auth",
        "registration",
        "rest-framework",
        "django-registration",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "600b344743248e8282e4355661d2e136fffbc80ceeeebe47f9c2c10eaf41dbca",
                "md5": "039e71d0ecb9ba543488f9d472e5dfcc",
                "sha256": "aad7d912476169e9991547bf98645344d3939be2d7052098048d819524c115d9"
            },
            "downloads": -1,
            "filename": "dj-rest-auth-5.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "039e71d0ecb9ba543488f9d472e5dfcc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 217511,
            "upload_time": "2023-11-15T04:02:07",
            "upload_time_iso_8601": "2023-11-15T04:02:07.330682Z",
            "url": "https://files.pythonhosted.org/packages/60/0b/344743248e8282e4355661d2e136fffbc80ceeeebe47f9c2c10eaf41dbca/dj-rest-auth-5.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-15 04:02:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iMerica",
    "github_project": "dj-rest-auth",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "tox": true,
    "lcname": "dj-rest-auth"
}
        
Elapsed time: 0.14086s