A Django app to different basic waitlists.
Project description
Django Dans Waitlist
Description
A Django app to handle waitlist and basic functionality.
Support for Waitlist
and WaitlistEntry
models, as well as a WaitlistManager
to handle common operations.
Quick start
- Install the package via pip:
pip install django-dans-waitlist
- Add "django_dans_waitlist" to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [
...
'django_dans_waitlist',
]
- Include the URL configs in your project
urls.py
for the REST API endpoints like this:
path("api/waitlist/", include("django_dans_waitlist.urls")),
-
Run
python manage.py migrate
to update your database schema. -
Use the API endpoints, in code or your Django admin portal.
Requirements
- Python 3.10 - 3.11
- Django 3.1 or higher
- Django Rest Framework
- NOTE: not only must you have this installed, you must have set
DEFAULT_AUTHENTICATION_CLASSES
andDEFAULT_PAGINATION_CLASS
in yoursettings.py
to work with the APIs properly. An example config would be:
- NOTE: not only must you have this installed, you must have set
REST_FRAMEWORK = {
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"PAGE_SIZE": 20,
"DEFAULT_AUTHENTICATION_CLASSES": (
"rest_framework.authentication.TokenAuthentication",
),
}
Available Settings
Currently all available settings are optional:
TEAM_NAME
- Default team name to use for emails, can be added to message context manually as well still.
Add these to your settings.py
file to customize the app's behavior like so:
TEAM_NAME = "My Team"
Usage
TODO
Docs
TODO - which of these are still relevant?
Model docs.
API docs.
https://danielnazarian.com
Copyright 2024 © Daniel Nazarian.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-dans-waitlist-0.0.1.tar.gz
(13.8 kB
view hashes)
Built Distribution
Close
Hashes for django-dans-waitlist-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c341c6439911f7e69c00e3114f4953f907c33c20123df70b86a4b5fb53f7e719 |
|
MD5 | 2dd85dad3954e3a9301a417610b67b67 |
|
BLAKE2b-256 | 0c323a27b48d2cc322a83d96d751540df6cf9e0443529acda2cbbd8e26d03073 |
Close
Hashes for django_dans_waitlist-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c065566f264b596d97540b10e6de8392fe0455adcd518d6d841974e704f460e |
|
MD5 | 9942cceb175ae837bd9503bbfc620d69 |
|
BLAKE2b-256 | 1f7ddc0cbe2ad706cae52614b552ffdd04bd3049448251aae15c202a5a65ea89 |