Welcome to dj-apis-allauth's documentation!
===================================
**dj-apis-allauth** (/lu'make/) is a Python Django library for
Django Rest Framework API Endpoints secure Authentications . This package is ideal for Mobile Applications or Single Page Application Integration such as Flutter, VueJs, React, AngularJs etc....
and offers a *simple* and *intuitive* API Endpoint Authentication.
Check out the :doc:`usage` section for further information, including
how to :ref:`installation` the project.
.. note::
This project is under active development.
Contents
--------
.. toctree::
usage
Add it to your project and use the Views and URLs( login, jwt_login, register)
api
# dj-apis-allauth
Django Rest Framework API Endpoints secure Authentications . This package is ideal for Mobile Applications or Single Page Application Integration such as Flutter, VueJs, React, AngularJs etc....
[](https://djangopackages.org/packages/p/dj-apis-allauth/)
# Why this project ?
The maintainer of "dj-rest-auth" is no longer interested in maintaining the project with Django-allauth issues and nor accepting pull requests.
So I have started this project to help the Good cause of Open Source Software greatness lives on.
So anybody that uses this package and willing to help maintain it is more than welcom to fork it and make a pull request.
Thanks.
# The regular django api token with user's info
This is the token and user info
# This is the JWT token return endpoint
# A simple registration page
## Requirements
- Django >= 4.2
- Python >= 3.12
## Quick Setup
Install package
pip install dj-apis-allauth
Add `dj_api_auth` app to INSTALLED_APPS in your django settings.py:
```python
INSTALLED_APPS = (
...,
'rest_framework',
'rest_framework.authtoken',
...,
'dj_apis_allauth'
)
```
Add URL patterns
```python
urlpatterns = [
path('dj_apis_allauth/', include("dj_apis_allauth.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_apis_allauth/tests/requirements.txt`
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
Work in progress...
### Acknowledgements
This project began as a fork of `django-rest-auth` and "dj-rest-auth" . Big thanks to everyone who contributed to that repo!
#### A note from Me
I will be trying my best to maintain this project but anyone is welcom to help maintain it.
There is so many features that I am planning on adding to this.
So feel free to make propositions on features that should be added.
Thanks.