https://github.com/fmarco/django-rest-invitations
A rest extension for django-invitations
https://github.com/fmarco/django-rest-invitations
api django django-invitations django-rest-framework django-rest-invitations extension invitation invite rest rest-api rest-framework website
Last synced: 1 day ago
JSON representation
A rest extension for django-invitations
- Host: GitHub
- URL: https://github.com/fmarco/django-rest-invitations
- Owner: fmarco
- License: gpl-3.0
- Created: 2017-06-06T10:09:27.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-12-18T17:58:15.000Z (over 4 years ago)
- Last Synced: 2025-09-27T18:21:55.284Z (6 months ago)
- Topics: api, django, django-invitations, django-rest-framework, django-rest-invitations, extension, invitation, invite, rest, rest-api, rest-framework, website
- Language: Python
- Homepage:
- Size: 36.1 KB
- Stars: 25
- Watchers: 1
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
## django-rest-invitations
[](https://travis-ci.org/fmarco/django-rest-invitations)
[](https://coveralls.io/github/fmarco/django-rest-invitations?branch=master)
Rest customizable extension for [django-invitations](https://github.com/bee-keeper/django-invitations)
Supported Python versions:
* 3.5
* 3.6
* 3.7
* 3.8
Supported Django versions:
* Django 1.11
* Django 2.0
* Django 3.0
Supported DRF versions:
* at least DRF 3.10 or greater
### Requirements
Make a proper setup for django-invitations.
### Installation
```
# Add to settings.py, INSTALLED_APPS
'rest_framework',
'invitations',
'rest_invitations'
# Append to urls.py
url(r'^', include('rest_invitations.urls'))
```
### Configuration
* `INVITATION_SERIALIZER_READ` (default=`rest_invitations.serializers.InvitationReadSerializer`)
Path. Serializer class for invitations (read)
* `INVITATION_SERIALIZER_WRITE` (default=`rest_invitations.serializers.InvitationWriteSerializer`)
Path. Serializer class for invitations (write)
* `INVITATION_SERIALIZER_WRITE_BULK` (default=`rest_invitations.serializers.InvitationBulkWriteSerializer`)
Path. Serializer class for invitations (bulk write)
* `INVITATION_API_BASE_URL` (default=`invitations`)
String. Base api url.
* `INVITATION_SEND_URL` (default=`send`)
String. Set up url on send endpoint
* `INVITATION_CREATE_AND_SEND_URL` (default=`create-and-send`)
String. Set up url on create_and_send endpoint
* `INVITATION_SEND_MULTIPLE_URL` (default=`send-multiple`)
String. Set up url on send_multiple endpoint
* `INVITATION_ACCEPT_INVITE_URL` (default=`accept-invite`)
String. Set up url for accept_invitation endpoint
### APIs (examples with default values)
* `Invitations list`
- /invitations/ (list, create)
body request (create): email (string)
* `Invitation detail`
- /invitations/``/ (retrieve, destroy)
* `Invitation send`
- /invitations/``/send/ (post)
body request: None
* `Invitation create and send`
- /invitations/create-and-send/ (post)
body request: email (string)
* `Invitation multiple send`
- /invitations/send-multiple/ (post)
body request: email: list of strings
* `Accept invitation`
- /invitations/accept-invite/``/ (get)
### Contributions
Feel free to contribute!