django-appointment 3.2.0

Managing appointment scheduling with customizable slots, staff features, and conflict handling.

Django Appointment 📦

⚠️ IMPORTANT: If upgrading from a version before 2.x.x, please note significant database changes were introduced in Version 2.0.0 introduces significant database changes. Please read the migration guide before updating. Version 3.x.x introduces the ability to send email reminders for appointments using Django Q for efficient task scheduling. It also allows clients to reschedule appointments if it is allowed by admins.

Django-Appointment is a Django app engineered for managing appointment scheduling with ease and flexibility. It enables users to define custom configurations for time slots, lead time, and finish time, or utilize the default values provided. This app proficiently manages conflicts and availability for appointments, ensuring a seamless user experience.

For a detailed walkthrough and live example of the system, please refer to this tutorial.

Detailed documentation can be found in the docs' directory. For changes and migration information, please refer to the release notes here and here.

Features ✨

1. Customizable time slots, lead time, and finish time.
2. Competent handling of appointment conflicts and availability.
3. Seamless integration with the Django admin interface for appointment management.
4. Custom admin interface for managing appointment/staff member editing, creation, availability, and conflicts.
5. User-friendly interface for viewing available time slots and scheduling appointments.
6. Capability to send email notifications to clients upon scheduling an appointment and email reminders for appointments, leveraging Django Q for task scheduling and efficiency.

Key features introduced in previous versions.

• For more information, please refer to this documentation.

Added Features and Bug Fixes in version 3.x.x

See the release notes. For older version, see their release notes.

Quick Start 🚀

1. Add "appointment" to your INSTALLED_APPS setting like so:

   INSTALLED_APPS = [
       # other apps
       'appointment',
       'django_q',
   ]
   

2. Incorporate the appointment URLconf in your project's urls.py like so:

   from django.urls import path, include
   
   urlpatterns = [
       # other urls
       path('appointment/', include('appointment.urls')),
   ]
   

3. In your Django's settings.py, append the following:

   AUTH_USER_MODEL = 'models.UserModel'  # Optional if you use Django's user model
   

   For instance, if you employ a custom user model:

   AUTH_USER_MODEL = 'client.UserClient'
   

   If you're utilizing the default Django user model, there's no need to add this line since Django automatically sets it to:

   AUTH_USER_MODEL = 'auth.User'
   

   Ensure your create_user function includes the following arguments, even if they are not all utilized:

   def create_user(first_name, email, username, last_name=None, **extra_fields):
       pass
   

   This function will create a user with a password formatted as: f"{APPOINTMENT_WEBSITE_NAME}{current_year}"

   For instance, if you append this to your settings.py:

   APPOINTMENT_WEBSITE_NAME = 'Chocolates'
   

   And the current year is 2023, the password will be "Chocolates2023". If APPOINTMENT_WEBSITE_NAME is not provided, the default value is "Website", rendering the password as "Website2023".

   This name is also utilized in the footer of the emails sent to clients upon scheduling an appointment:

   <p>® 2023 {{ APPOINTMENT_WEBSITE_NAME }}. All Rights Reserved.</p>
   

   Configure Q_CLUSTER in your Django's settings.py to enable Django Q task scheduling:

      Q_CLUSTER = {
        'name': 'DjangORM',
        'workers': 4,
        'timeout': 90,
        'retry': 120,
        'queue_limit': 50,
        'bulk': 10,
        'orm': 'default',
      }
   

4. Run python manage.py migrate to create the appointment models.

5. Start the Django Q cluster with python manage.py qcluster.

6. Launch the development server and navigate to http://127.0.0.1:8000/admin/ to create appointments, manage configurations, and handle appointment conflicts (the Admin app must be enabled).

7. You must create at least one service before using the application on the admin page. If your service is free, input 0 as the price. If your service is paid, input the price in the price field. You may also provide a description for your service.

8. Visit http://127.0.0.1:8000/appointment/request/<service_id>/ to view the available time slots and schedule an appointment.

Customization 🔧

1. In your Django project's settings.py, you can override the default values for the appointment scheduler. More information regarding available configurations can be found in the documentation.
2. Modify these values as needed for your application, and the app will adapt to the new settings.
3. For further customization, you can extend the provided models, views, and templates or create your own.

Support 💬

For support or inquiries regarding the Appointment Scheduler app, please refer to the documentation in the "docs" directory or visit the GitHub repository for more information.

Contributing 🤝

Contributions are welcome! Please refer to the contributing guidelines for more information.

Code of Conduct 📜

Please refer to the code of conduct for more information.

Security policy 🔒

Please refer to the security policy for more information.

Notes 📝⚠️

I'm working on a testing website for the application that is not fully functional yet, no hard feelings. But you can check it out at https://django-appt.adamspierredavid.com/. Ideas are welcome here since I'm blocked on a few points.

About the Author

Adams Pierre David - Website