django-birthday is a helper library to work with birthdays in models.
Maintained by Basil Shubin, and some great contributors.
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install django-birthday
django-birthday provides a birthday.fields.BirthdayField
model
field type which is a subclass of django.db.models.DateField
and
thus has the same characteristics as that. It also internally adds a
second field to your model holding the day of the year for that
birthday, this is used for the extra functionality exposed by
birthday.managers.BirthdayManager
which you should use as the
manager on your model.
A model could look like this:
from django.db import models
from django.conf import settings
from birthday import BirthdayField, BirthdayManager
class UserProfile(models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL)
birthday = BirthdayField()
objects = BirthdayManager()
Get all user profiles within the next 30 days:
UserProfile.objects.get_upcoming_birthdays()
Get all user profiles which have their birthday today:
UserProfile.objects.get_birthdays()
Or order the user profiles according to their birthday:
UserProfile.objects.order_by_birthday()
For more details, see the documentation at Read The Docs.
If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)
django-birthday was originally started by Jonas Obrist who has now unfortunately abandoned the project.
django-birthday
is released under the BSD license.