Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/101loop/drf-user

This Django User Model is customised user model keeping in mind the practical need (esp. in India)
https://github.com/101loop/drf-user

django django-admin django-api django-application django-apps django-rest django-rest-framework django-user django-user-management django2 hacktoberfest otp otp-verification python registration-system rest-api signup-flow user-management

Last synced: 7 days ago
JSON representation

This Django User Model is customised user model keeping in mind the practical need (esp. in India)

Host: GitHub
URL: https://github.com/101loop/drf-user
Owner: 101Loop
License: gpl-3.0
Created: 2017-07-04T10:07:18.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-10-14T21:48:44.000Z (4 months ago)
Last Synced: 2025-01-26T06:05:20.654Z (7 days ago)
Topics: django, django-admin, django-api, django-application, django-apps, django-rest, django-rest-framework, django-user, django-user-management, django2, hacktoberfest, otp, otp-verification, python, registration-system, rest-api, signup-flow, user-management
Language: Python
Homepage: https://drf-user.readthedocs.io
Size: 445 KB
Stars: 156
Watchers: 7
Forks: 70
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![Build Status](https://github.com/101loop/drf-user/workflows/CI/badge.svg)

[![codecov](https://codecov.io/gh/101Loop/drf-user/branch/master/graph/badge.svg)](https://codecov.io/gh/101Loop/drf-user)

[![Downloads](https://static.pepy.tech/personalized-badge/drf-user?period=total&units=international_system&left_color=black&right_color=blue&left_text=Total%20Downloads)](https://pepy.tech/project/drf-user)

[![Downloads](https://static.pepy.tech/personalized-badge/drf-user?period=month&units=international_system&left_color=black&right_color=blue&left_text=Downloads/Month)](https://pepy.tech/project/drf-user)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/101Loop/drf-user/master.svg)](https://results.pre-commit.ci/latest/github/101Loop/drf-user/master)

[![Documentation Status](https://readthedocs.org/projects/drf-user/badge/?version=latest)](https://drf-user.readthedocs.io/en/latest/?badge=latest)

[![Documentation Coverage](https://drf-user.readthedocs.io/en/latest/_static/interrogate_badge.svg)](https://github.com/101loop/drf-user)

# Django REST Framework - User

> One of the winners of [PyCharm Project of the Decade Competition](https://www.jetbrains.com/lp/pycharm-10-years/)

---

**User APP for Django REST Framework with API Views.**


`DRF User` is a Django app that overrides default user app to provide additional attributes and functionalities. The

current stable version includes:

- JWT Support (Using [Simple JWT](https://django-rest-framework-simplejwt.readthedocs.io/))

- Mobile Number

- Single field for full name

- REST API to register

- REST API to login

- MultiModelBackend: User can login using either of mobile, email or username

- REST API to login with OTP (Same API endpoint as for OTP Verification; Set

  `is_login: true` while sending JSON request)

- OTP Verification for mobile and email

- API to register / login with OTP (no pre-registration required)

- API to set user's profile image

- Mail sending feature upon successful registration

- SMS sending feature upon successful registration

- Change Password

- Update Profile

- Generic Configuration based on settings.py

- Signal based mails

- Mail based activation (optional alternative for OTP based activation)

- Social Auth Endpoints(Login using fb/google) (WIP)

# Documentation

---

- For more information on installation and configuration see the documentation at: https://drf-user.readthedocs.io/

# Example

---

To get the example project running do:

- Clone this repo

    ```shell

    $ git clone https://github.com/101Loop/drf-user.git

    ```

- Go to `example` folder in newly created directory `drf-user`

    ```shell

    $ cd drf-user/example

    ```

- Create and activate virtual environment.

- Install requirements

    ```shell

    (.venv) $ pip install -r requirements.txt

    ```

- Run testing server:

    ```shell

    (.venv) $ python manage.py runserver

    ```

Take a look at `http://localhost:8000/swagger`. Swagger will list all the APIs of drf-user.

# Contributing

---

- Please file bugs and send pull requests to the

  [GitHub Repository](https://github.com/101loop/drf-user) and

  [Issue Tracker](https://github.com/101loop/drf-user/issues). See

  [CONTRIBUTING.md](https://github.com/101Loop/drf-user/blob/master/CONTRIBUTING.md)

  for details.

* For help and support please reach out to us on

  [Slack](https://101loop.slack.com).