Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrobern/django-graphql-auth
Django registration and authentication with GraphQL.
https://github.com/pedrobern/django-graphql-auth
authentication django graphene graphql python registration relay
Last synced: 4 days ago
JSON representation
Django registration and authentication with GraphQL.
- Host: GitHub
- URL: https://github.com/pedrobern/django-graphql-auth
- Owner: PedroBern
- License: mit
- Created: 2020-01-15T16:36:01.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T13:07:28.000Z (5 months ago)
- Last Synced: 2024-12-19T20:04:44.846Z (4 days ago)
- Topics: authentication, django, graphene, graphql, python, registration, relay
- Language: Python
- Homepage: https://django-graphql-auth.readthedocs.io/en/latest/
- Size: 6.12 MB
- Stars: 333
- Watchers: 21
- Forks: 107
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Django GraphQL Auth
[Django](https://github.com/django/django) registration and authentication with GraphQL.
[](https://pypistats.org/packages/django-graphql-auth)
[](https://codecov.io/gh/pedrobern/django-graphql-auth/)
[](https://travis-ci.com/pedrobern/django-graphql-auth)
[](https://pypi.org/project/django-graphql-auth/)
[](https://django-graphql-auth.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/pedrobern/django-graphql-auth/blob/master/CONTRIBUTING.md)
## Demo
## About
Abstract all the basic logic of handling user accounts out of your app,
so you don't need to think about it and can **get up and running faster**.
No lock-in. When you are ready to implement your own code or this package
is not up to your expectations , it's *easy to extend or switch to
your implementation*.
## Documentation
Documentation is available at [read the docs](https://django-graphql-auth.readthedocs.io/en/latest/).
## Features
* [x] [Awesome docs](https://django-graphql-auth.readthedocs.io/en/latest/) :tada:
* [x] Fully compatible with [Relay](https://github.com/facebook/relay>)
* [x] Works with **default or custom** user model
* [x] JWT authentication *(with [Django GraphQL JWT](https://github.com/flavors/django-graphql-jwt))*
* [x] User query with filters *(with [Django Filter](https://github.com/carltongibson/django-filter) and [Graphene Django](https://github.com/graphql-python/graphene-django))*
* [x] User registration with email verification
* [x] Add secondary email, with email verification too
* [x] Resend activation email
* [x] Retrieve/Update user
* [x] Archive user
* [x] Permanently delete user or make it inactive
* [x] Turn archived user active again on login
* [x] Track user status (archived, verified, secondary email)
* [x] Password change
* [x] Password reset through email
* [x] Revoke user refresh tokens on account archive/delete/password change/reset
* [x] All mutations return `success` and `errors`
* [x] Default email templates *(you will customize though)*
* [x] Customizable, no lock-in
## Full Schema
```python
import graphene
from graphql_auth.schema import UserQuery, MeQuery
from graphql_auth import mutations
class AuthMutation(graphene.ObjectType):
register = mutations.Register.Field()
verify_account = mutations.VerifyAccount.Field()
resend_activation_email = mutations.ResendActivationEmail.Field()
send_password_reset_email = mutations.SendPasswordResetEmail.Field()
password_reset = mutations.PasswordReset.Field()
password_set = mutations.PasswordSet.Field() # For passwordless registration
password_change = mutations.PasswordChange.Field()
update_account = mutations.UpdateAccount.Field()
archive_account = mutations.ArchiveAccount.Field()
delete_account = mutations.DeleteAccount.Field()
send_secondary_email_activation = mutations.SendSecondaryEmailActivation.Field()
verify_secondary_email = mutations.VerifySecondaryEmail.Field()
swap_emails = mutations.SwapEmails.Field()
remove_secondary_email = mutations.RemoveSecondaryEmail.Field()
# django-graphql-jwt inheritances
token_auth = mutations.ObtainJSONWebToken.Field()
verify_token = mutations.VerifyToken.Field()
refresh_token = mutations.RefreshToken.Field()
revoke_token = mutations.RevokeToken.Field()
class Query(UserQuery, MeQuery, graphene.ObjectType):
pass
class Mutation(AuthMutation, graphene.ObjectType):
pass
schema = graphene.Schema(query=Query, mutation=Mutation)
```
## Relay
Import mutations from the ``relay`` module:
```python
from graphql_auth import relay
class AuthMutation(graphene.ObjectType):
register = relay.Register.Field()
# ...
```
## Example
Handling user accounts becomes super easy.
```python
mutation {
register(
email: "[email protected]",
username: "new_user",
password1: "123456super",
password2: "123456super",
) {
success,
errors,
token,
refreshToken
}
}
```
Check the status of the new user:
```python
u = UserModel.objects.last()
u.status.verified
# False
```
During the registration, an email with a verification link was sent.
```python
mutation {
verifyAccount(
token:"",
) {
success,
errors
}
}
```
Now user is verified.
```python
u.status.verified
# True
```
Check the [installation guide](https://django-graphql-auth.readthedocs.io/en/latest/installation/) or jump to the [quickstart](https://django-graphql-auth.readthedocs.io/en/latest/quickstart/). Or if you prefer, browse the [api](https://django-graphql-auth.readthedocs.io/en/latest/api/).
## Contributing
See [CONTRIBUTING.md](https://github.com/pedrobern/django-graphql-auth/blob/master/CONTRIBUTING.md)