Setup fixes (#45)

adamspd · web-flow · commit 87ec0b821b09 · 2023-12-03T01:25:57.000+01:00
* minor-fixes

* Updated readmes and deployment method
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -21,7 +21,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine requests build  # Added requests for the version check
+        pip install setuptools wheel twine requests 
 
     # Check if the current version is already on PyPI
     - name: Check version on PyPI
@@ -34,12 +34,12 @@ jobs:
     - name: Build package
       if: steps.version_check.outputs.version_exists != 'true'
       run: |
-        python3 setup.py sdist bdist_wheel
+        python setup.py sdist bdist_wheel
 
     - name: Upload to PyPI
       if: steps.version_check.outputs.version_exists != 'true'
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        twine upload dist/*
+        twine upload dist/*
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -27,14 +27,18 @@ recursive-include appointment/static/css *.css
 recursive-include appointment/static/js *.js
 recursive-include appointment/static/img *.jpg
 recursive-include appointment/templates/ *.html
-recursive-include appointment/tests/base *.py
-recursive-include appointment/tests/mixins *.py
-recursive-include appointment/tests/models *.py
-recursive-include appointment/tests/utils *.py
 recursive-include appointment/tests *.py
 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__
 exclude appointment/django_appointment.egg-info/PKG-INFO
@@ -44,5 +48,6 @@ exclude appointment/django_appointment.egg-info/requires.txt
 exclude appointment/django_appointment.egg-info/top_level.txt
 
 # Recursive exclusions
-recursive-exclude appointment/migrations *
-recursive-exclude appointments *
+recursive-exclude appointment/migrations *.py
+recursive-exclude appointments *.py
+recursive-exclude appointment *.pyc
diff --git a/appointment/__init__.py b/appointment/__init__.py
@@ -4,4 +4,4 @@
 __description__ = "Managing appointment scheduling with customizable slots, staff features, and conflict handling."
 __package_name__ = "django-appointment"
 __url__ = "https://github.com/adamspd/django-appointment"
-__version__ = "2.1.5.dev1"
+__version__ = "2.1.1"
diff --git a/docs/admin_views.md b/docs/admin_views.md
@@ -22,6 +22,7 @@ Example:
 ```html
 
 <head>
+    <title>My title</title>
     ...
     {% block customMetaTag %}
     {% endblock %}
@@ -110,7 +111,7 @@ Failure to include this block might result in errors during asynchronous operati
     - **Endpoint**: `email_change_verification_code/`
     - **Description**: When a user changes their email, they need to verify the new email through a code. This endpoint
       handles the verification process.
-    - **Methods**: GET (display verification code form), POST (submit verification code)
+    - **Methods**: GET (it displays a verification code form), POST (submit verification code)
 
 #### **Days Off Management**:
 
@@ -152,8 +153,8 @@ Failure to include this block might result in errors during asynchronous operati
 - **Delete Working Hours**:
     - **Endpoint**: `delete-working-hours/`, `delete-working-hours/<int:working_hours_id>/`,
       and `delete-working-hours/<int:working_hours_id>/<int:staff_user_id>/`
-    - **Description**: Users can remove a working hours entry. Superusers can delete any entry, while staff members can
-      only delete their own.
+    - **Description**: Users can remove a working hours' entry.
+      Superusers can delete any entry, while staff members can only delete their own.
     - **Methods**: GET
 
 ### Note on updating personal info
diff --git a/docs/models.md b/docs/models.md
@@ -1,4 +1,4 @@
-- [Django Appointment System](#django-appointment-system)
+- [Django Appointment System]()
     * [Models](#models)
         + [Service](#service)
         + [StaffMember](#staffmember)
@@ -149,13 +149,11 @@ appointment request.
 - `get_service_img_url`: Returns the URL of the service's image.
 - `get_service_description`: Returns the description of the service.
 - `get_appointment_date`: Returns the date of the appointment.
-- `is_paid`: Returns whether the appointment has been paid for.
+- `is_paid`: Returns if the appointment has been paid for.
 - `get_appointment_amount_to_pay`: Returns the amount to be paid for the appointment.
 - `get_appointment_amount_to_pay_str`: Returns a formatted amount to pay text.
 - `get_appointment_currency`: Returns the currency of the appointment price.
 - `get_appointment_id_request`: Returns the ID of the appointment.
-- `get_created_at`: Returns the timestamp when the appointment was created.
-- `get_updated_at`: Returns the timestamp when the appointment was last updated.
 - `set_appointment_paid_status`: Sets the paid status of the appointment.
 - `get_absolute_url`: Returns the absolute URL for the appointment.
 - `get_background_color`: Returns the background color of the service.
@@ -266,7 +264,7 @@ The `WorkingHours` model represents the working hours for a staff member on a sp
 - `clean`: Validates that the `start_time` is before the `end_time`.
 - `get_start_time`: Returns the start time of the working hours.
 - `get_end_time`: Returns the end time of the working hours.
-- `get_day_of_week_str`: Returns the name of the day of the week.
+- `get_day_of_week_str`: Returns the name of the day.
 - `is_owner`: Returns a boolean indicating if the given user ID matches the user ID of the staff member associated with
   the working hours.
 
diff --git a/docs/payment_url_configuration.md b/docs/payment_url_configuration.md
@@ -7,7 +7,7 @@ determines where the user is redirected for payment processing after an appointm
 
 ### 1. Direct Payment Gateway URL:
 
-If you have a direct URL to a payment gateway or an external payment page, you can simply set
+If you have a direct URL to a payment gateway or an external payment page, you can set
 the `APPOINTMENT_PAYMENT_URL` to that URL. For instance:
 
 ```python
diff --git a/docs/views.md b/docs/views.md
@@ -1,4 +1,4 @@
-- [Django Appointment](#django-appointment-system) 
+- [Django Appointment]() 
   * [Views](#views)
     + [get_available_slots_ajax](#get-available-slots-ajax)
     + [get_next_available_date_ajax](#get-next-available-date-ajax)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools >= 61.0"]
-build-backend = "setuptools.build_meta"
+requires = ['setuptools>=40.8.0', 'wheel']
+build-backend = 'setuptools.build_meta:__legacy__'
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,30 @@
+[metadata]
+license = Apache License 2.0
+classifiers =
+    Development Status :: 3 - Alpha
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Framework :: Django
+    Framework :: Django :: 4.2
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+    Operating System :: OS Independent
+    Environment :: Web Environment
+    Topic :: Internet :: WWW/HTTP
+    Topic :: Internet :: WWW/HTTP :: Dynamic Content
+    Topic :: Software Development :: Libraries :: Application Frameworks
+
+[options]
+include_package_data = true
+packages = find:
+python_requires = >=3.8
+install_requires =
+    Django>=4.2
+    Pillow>=10.1.0
+    phonenumbers>=8.13.22
+    django-phonenumber-field>=7.2.0
+    babel>=2.13.0
+    pytz>=2023.3
diff --git a/setup.py b/setup.py
@@ -18,45 +18,4 @@
     project_urls={
         "Author Website": __author_website__,
     },
-    packages=setuptools.find_packages(where="appointments"),
-    package_dir={"": "appointment"},
-    include_package_data=True,
-    classifiers=[
-        # Maturity of project
-        #   3 - Alpha
-        #   4 - Beta
-        #   5 - Production/Stable
-        'Development Status :: 3 - Alpha',
-
-        # Intended for
-        'Intended Audience :: Developers',
-
-        # License
-        "License :: OSI Approved :: Apache Software License",
-
-        # Python versions supported.
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-
-        # OS
-        "Operating System :: OS Independent",
-
-        # Topic
-        "Topic :: Internet :: WWW/HTTP",
-        "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
-        "Topic :: Software Development :: Libraries :: Application Frameworks",
-    ],
-    license="Apache License 2.0",
-    python_requires='>=3.8',
-    install_requires=[
-        "Django>=4.2",
-        "Pillow>=10.1.0",
-        "phonenumbers>=8.13.22",
-        "django-phonenumber-field>=7.2.0",
-        "babel>=2.13.0",
-        "pytz>=2023.3",
-    ]
 )

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-- [Django Appointment](#django-appointment-system)`
	`1`	`+- [Django Appointment]()`
`2`	`2`	`* [Views](#views)`
`3`	`3`	`+ [get_available_slots_ajax](#get-available-slots-ajax)`
`4`	`4`	`+ [get_next_available_date_ajax](#get-next-available-date-ajax)`