Staff functionality with admin interface (#7)

* Added staff functionality
Admin interface
Slot availability
Extensive documentation
GitHub workflow
Extensive tests

* updated publish workflow

Author: adamspd

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Upload Python Package to PyPI on Push to Main
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine requests  # Added requests for the version check
+
+    # Check if the current version is already on PyPI
+    - name: Check version on PyPI
+      run: |
+        python check_version.py  # This script now checks against real PyPI
+
+    # Build the package (folder exclusion is handled by MANIFEST.in)
+    - name: Build package
+      run: |
+        python setup.py sdist bdist_wheel
+
+    - name: Upload to PyPI
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        twine upload dist/*

.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Testing workflow
+
+on:
+  push:
+    branches-ignore:
+      - 'main'
+  workflow_dispatch:
+
+jobs:
+  running_tests:
+    runs-on: ubuntu-20.04
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.10.5]
+        fail-fast: [false]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install coverage
+    - name: Run Tests
+      run: |
+        coverage run --source=appointment manage.py test appointment.tests --verbosity=1
+        coverage report

.gitignore

@@ -173,4 +173,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
-.DS_Store
+.DS_Store
+**/.DS_Store/**
+**/migrations/**

MANIFEST.in

@@ -1,15 +1,49 @@
+# Include files
 include LICENSE
 include README.md
-recursive-include appointment/templates/appointment *.html
-recursive-include appointment/templates/base_templates *.html
-recursive-include appointment/templates/email_sender *.html
+include requirements.txt
+include setup.cfg
+include setup.py
+include pyproject.toml
+include MANIFEST.in
+
+# Include appointment main files
+include appointment/__init__.py
+include appointment/admin.py
+include appointment/apps.py
+include appointment/decorators.py
+include appointment/email_messages.py
+include appointment/forms.py
+include appointment/logger_config.py
+include appointment/models.py
+include appointment/services.py
+include appointment/settings.py
+include appointment/urls.py
+include appointment/views.py
+include appointment/views_admin.py
+
+# Recursive includes
+recursive-include appointment/email_sender *.py
 recursive-include appointment/static/css *.css
 recursive-include appointment/static/js *.js
 recursive-include appointment/static/img *.jpg
-recursive-include appointment/email_sender *.py
+recursive-include appointment/templates/ *.html
 recursive-include appointment/tests *.py
-recursive-include appointment *.py
-recursive-include docs *
-include logger_config.py
-include release_notes.md
-exclude appointment/__pycache__
+recursive-include appointment/utils *.py
+
+# Exclusions
+exclude release_notes.md
+exclude check_version.py
+exclude manage.py
+exclude db.sqlite3
+exclude .gitignore
+exclude .git
+exclude .svn
+exclude .hg
+exclude appointment/__pycache__
+exclude appointment/migrations/__pycache__
+
+# Recursive exclusions
+recursive-exclude appointment/migrations *.py
+recursive-exclude appointments *.py
+recursive-exclude appointment *.pyc

README.md

@@ -1,24 +1,38 @@
-# Django Appointment
+# Django Appointment 📦
 
-Django-Appointment is a Django app designed for managing appointment scheduling with ease and flexibility. It allows
-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.
+⚠️ **IMPORTANT**: Version 2.0.0 introduces significant database changes. Please read the [migration guide](https://github.com/adamspd/django-appointment/tree/main/migration_guide_v2.0.0.md) before updating.
 
-Detailed documentation is in the ["docs"](https://github.com/adamspd/django-appointment/tree/main/docs) directory.
-Please refer to the release notes for changes and migration
-information [here](https://github.com/adamspd/django-appointment/tree/main/release_notes.md).
+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.
 
-## Features
+Detailed documentation can be found in the [docs](https://github.com/adamspd/django-appointment/tree/main/docs)
+directory.
+For changes and migration information, please refer to the release
+notes [here](https://github.com/adamspd/django-appointment/tree/main/release_notes.md).
+
+## Features ✨
 
 1. Customizable time slots, lead time, and finish time.
-2. Handles appointment conflicts and availability.
-3. Easy integration with Django admin interface for appointment management.
+2. Competent handling of appointment conflicts and availability.
+3. Seamless integration with the Django admin interface for appointment management.
 4. User-friendly interface for viewing available time slots and scheduling appointments.
-5. Send email notifications to clients when they schedule an appointment.
+5. Capability to send email notifications to clients upon scheduling an appointment.
+
+## Added Features in version 2.0.0 🆕
+- **Database Changes ⚠️**: Significant modifications to the database schema. Before updating, ensure you follow the migration steps outlined in the [migration guide](https://github.com/adamspd/django-appointment/tree/main/migration_guide_v2.0.0.md).
+1. Introduced a staff feature allowing staff members in a team or system to manage their own appointments.
+2. Implemented an admin feature panel enabling staff members and superusers (admins) to manage the system.
+3. Added buffer time between the current time and the first available slot for the day.
+4. Defined working hours for each staff member, along with the specific days they are available during the week.
+5. Specified days off for staff members to represent holidays or vacations.
+6. Staff members can now define their own configuration settings for the appointment system, such as slot duration,
+   working hours, and buffer time between appointments. However, only admins have the privilege to add/remove services.
 
-## Quick start
+## Quick Start 🚀
 
-1. Add "appointment" to your INSTALLED_APPS setting like this:
+1. Add "appointment" to your `INSTALLED_APPS` setting like so:
 
    ```python
    INSTALLED_APPS = [
@@ -27,7 +41,7 @@ information [here](https://github.com/adamspd/django-appointment/tree/main/relea
    ]
    ```
 
-2. Include the appointment URLconf in your project urls.py like this:
+2. Incorporate the appointment URLconf in your project's `urls.py` like so:
 
    ```python
    from django.urls import path, include
@@ -38,92 +52,71 @@ information [here](https://github.com/adamspd/django-appointment/tree/main/relea
    ]
    ```
 
-3. In your Django's settings.py, add the following:
+3. In your Django's `settings.py`, append the following:
 
    ```python
-   APPOINTMENT_CLIENT_MODEL = models.UserModel  # Not optional (e.g. auth.User, or client.UserClient)
+   AUTH_USER_MODEL = 'models.UserModel'  # Optional if you use Django's user model
    ```
-
-   For example, if you use the default Django user model:
-
+   
+   For instance, if you employ a custom user model:
+   
    ```python
-   APPOINTMENT_CLIENT_MODEL = auth.User
+   AUTH_USER_MODEL = 'client.UserClient'
    ```
-
-   Or, if you use a custom user model:
-
+   
+   If you're utilizing the default Django user model, there's no need to add this line since Django automatically sets it
+   to:
+   
    ```python
-   APPOINTMENT_CLIENT_MODEL = client.UserClient
+   AUTH_USER_MODEL = 'auth.User'
    ```
-
-   If you have a custom user model, make sure your create_user function includes the following arguments, even if you
-   don't use all of them:
-
+   
+   Ensure your `create_user` function includes the following arguments, even if they are not all utilized:
+   
    ```python
-   def create_user(first_name, email, username, **extra_fields):
+   def create_user(first_name, email, username, last_name=None, **extra_fields):
        pass
    ```
-
-   This will create a user with a password in the format: f"{APPOINTMENT_WEBSITE_NAME}{current_year}"
-
-   For example, if you add this to your settings.py:
-
+   
+   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`:
+   
    ```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".
-
-   This name is also used in the footer of the emails sent to the clients when they schedule an appointment.
+   
+   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:
+   
    ```html
-    <p>® 2023 {{ APPOINTMENT_WEBSITE_NAME }}. All Right Reserved.</p>
+   <p>® 2023 {{ APPOINTMENT_WEBSITE_NAME }}. All Rights Reserved.</p>
    ```
 
-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).
-
-
-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.
-
+4. Execute `python manage.py migrate` to create the appointment models.
+5. 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).
+6. 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.
 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_BASE_TEMPLATE = 'base_templates/base.html'  # your base template
-   APPOINTMENT_WEBSITE_NAME = 'Website'
-   APPOINTMENT_PAYMENT_URL = None  # example of pattern 'payment:payment_linked
-   APPOINTMENT_THANK_YOU_URL = None  # example of pattern 'payment:thank_you'
-   
-   # Additional to the default email settings
-   APP_DEFAULT_FROM_EMAIL = "webmaster@localhost"  # the default from email that you're using
-   ```
-
-2. Modify these values as needed for your application, and the scheduler will adapt to the new settings.
+## Customization 🔧
 
-3. To further customize the app, you can extend the provided models, views, and templates or create your own.
+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 [here](docs/README.md#configuration).
+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
+## Support 💬
 
-For support or questions regarding the Appointment Scheduler app, please refer to the documentation in the "docs"
+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.
 
-## Notes
+## 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.
+Currently, the application does not send email reminders yet.