version 1.0.2

Author: adamspd

MANIFEST.in

@@ -1,6 +1,9 @@
 include LICENSE
-include README.rst
-recursive-include appointment *
-recursive-include appointment/templates *.html
-recursive-include appointment/static *.css *.js
+include README.md
+recursive-include appointment/migrations *.py
+recursive-include appointment/templates/appointment *.html
+recursive-include appointment/templates/base_templates *.html
+recursive-include appointment/static/css *.css
+recursive-include appointment/static/js *.js
+recursive-include appointment *.py
 recursive-include docs *

README.md

@@ -4,7 +4,7 @@ Appointment Scheduler is a Django app designed for managing appointment scheduli
 users to define custom configurations for time slots, lead time, and finish time, or use the default values provided.
 The app also handles conflicts and availability for appointments, ensuring a smooth user experience.
 
-Detailed documentation is in the "docs" directory.
+Detailed documentation is in the ["docs"](docs/README.md) directory.
 
 ## Features
 
@@ -19,7 +19,7 @@ Detailed documentation is in the "docs" directory.
 
 ```python
 INSTALLED_APPS = [
-    '...',
+    ...
     'appointment',
 ]
 ```
@@ -30,36 +30,74 @@ INSTALLED_APPS = [
 from django.urls import path, include
 
 urlpatterns = [
-    '...',
+    ...
     path('appointment/', include('appointment.urls')),
 ]
 ```
 
-3. Run `python manage.py migrate` to create the appointment models.
+3. In your Django's settings.py, add the following:
 
-4. Start the development server and visit http://127.0.0.1:8000/admin/
+```python
+APPOINTMENT_CLIENT_MODEL = file.UserModel  # Not optional (e.g. auth.User, or client.UserClient)
+```
+
+for example if you use the default Django user model:
+
+```python
+APPOINTMENT_CLIENT_MODEL = auth.User
+```
+
+or if you use a custom user model:
+
+```python
+APPOINTMENT_CLIENT_MODEL = client.UserClient
+```
+
+Now if you have a custom user model, in your function create_user, you have to have the following arguments even if you
+don't use all of them:
+
+```python
+def create_user(first_name, email, username, **extra_fields):
+    pass
+```
+
+This will create a user with the password = f"{APPOINTMENT_WEBSITE_NAME}{current_year}"
+
+For example if you put in your settings.py:
+
+```python
+APPOINTMENT_WEBSITE_NAME = 'Chocolates'
+```
+
+and the current year is 2023, the password will be "Chocolates2023" if you don't provide an APPOINTMENT_WEBSITE_NAME,
+the default value is "Website", so the password will be "Website2023".
+
+4. Run `python manage.py migrate` to create the appointment models.
+
+
+5. Start the development server and visit http://127.0.0.1:8000/admin/
    to create appointments, manage configurations, and handle appointment conflicts (you'll need the Admin app enabled).
 
-5. You have to create at least a service before using the application in the admin page. If your service is free, add 0
+
+6. You have to create at least a service before using the application in the admin page. If your service is free, add 0
    as the price. If you want to charge for your service, add the price in the price field. You can also add a
-   description
-   for your service.
+   description for your service.
 
-6. Visit http://127.0.0.1:8000/appointment/request/<service_id>/ to view the available time slots and schedule an
+7. 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:
 
 ```python
+# Default values
 APPOINTMENT_SLOT_DURATION = 30  # minutes
 APPOINTMENT_LEAD_TIME = (9, 0)  # (hour, minute) 24-hour format
 APPOINTMENT_FINISH_TIME = (16, 30)  # (hour, minute) 24-hour format
 
 # Additional configuration options
-APPOINTMENT_CLIENT_MODEL = 'auth.User'
-APPOINTMENT_BASE_TEMPLATE = 'base_templates/base.html'
+APPOINTMENT_BASE_TEMPLATE = 'base_templates/base.html'  # your base template
 APPOINTMENT_WEBSITE_NAME = 'Website'
 APPOINTMENT_PAYMENT_URL = None
 APPOINTMENT_THANK_YOU_URL = None
@@ -73,3 +111,8 @@ APPOINTMENT_THANK_YOU_URL = None
 
 For support or questions regarding the Appointment Scheduler app, please refer to the documentation in the "docs"
 directory or visit the GitHub repository for more information.
+
+## Notes
+
+The application doesn't send confirmation emails on appointment creation yet, but it will be implemented soon.
+Also the application doesn't send email reminders yet.

appointment/settings.py

@@ -1,8 +1,8 @@
 from django.conf import settings
 
-APPOINTMENT_CLIENT_MODEL = getattr(settings, 'APPOINTMENTS_CLIENT_MODEL', 'auth.User')
+APPOINTMENT_CLIENT_MODEL = getattr(settings, 'APPOINTMENT_CLIENT_MODEL')
 APPOINTMENT_BASE_TEMPLATE = getattr(settings, 'APPOINTMENT_BASE_TEMPLATE', 'base_templates/base.html')
-APPOINTMENT_WEBSITE_NAME = getattr(settings, 'WEBSITE_NAME', 'Website')
+APPOINTMENT_WEBSITE_NAME = getattr(settings, 'APPOINTMENT_WEBSITE_NAME', 'Website')
 APPOINTMENT_PAYMENT_URL = getattr(settings, 'APPOINTMENT_PAYMENT_URL', None)
 APPOINTMENT_THANK_YOU_URL = getattr(settings, 'APPOINTMENT_THANK_YOU_URL', None)
 APPOINTMENT_SLOT_DURATION = getattr(settings, 'APPOINTMENT_SLOT_DURATION', 30)

docs/README.md

@@ -31,7 +31,7 @@ the information about the appointment.
 
 ### Appointment
 The appointment model is used to define the last step in the appointment scheduling. It has the following fields:
-- client: The client that made the appointment, (default model : auth.User)
+- client: The client that made the appointment
 - appointment_request: The appointment request that the appointment is based on
 - phone: The phone number of the client
 - address: The address of the client

setup.cfg

@@ -1,11 +1,11 @@
 [metadata]
 name = django-appointment
-version = 1.0.0
-description = "A Django app for managing appointment scheduling with ease and flexibility."
+version = 1.0.2
+description = A Django app for managing appointment scheduling with ease and flexibility.
 url = https://github.com/adamspd/django-appointment
-author = "Adams Pierre David"
-author_email = "[email protected]"
-author_website = "https://adamspierredavid.com/"
+author = Adams Pierre David
+author_email = [email protected]
+author_website = https://adamspierredavid.com/
 readme = README.md
 license = Apache License 2.0
 classifiers =
@@ -22,10 +22,12 @@ classifiers =
     Programming Language :: Python :: 3.11
     Topic :: Internet :: WWW/HTTP
     Topic :: Internet :: WWW/HTTP :: Dynamic Content
+    Topic :: Software Development :: Libraries :: Application Frameworks
+    Topic :: Software Development :: Libraries :: Django
 
 [options]
 include_package_data = true
 packages = find:
-python_requires = >=3.10
+python_requires = >=3.8
 install_requires =
     Django >= 4.2