django-handyhelpers 0.3.18__py3-none-any.whl → 0.3.20__py3-none-any.whl

{django_handyhelpers-0.3.18.dist-info → django_handyhelpers-0.3.20.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: django-handyhelpers
-Version: 0.3.18
+Version: 0.3.20
 Summary: A collection of handy utilities to support django operations
 Home-page: https://github.com/davidslusser/django-handyhelpers
-Download-URL: https://github.com/davidslusser/django-handyhelpers/archive/0.3.18.tar.gz
+Download-URL: https://github.com/davidslusser/django-handyhelpers/archive/0.3.20.tar.gz
 Author: David Slusser
 Author-email: dbslusser@gmail.com
 License: GPL-3.0

{django_handyhelpers-0.3.18.dist-info → django_handyhelpers-0.3.20.dist-info}/RECORD

@@ -1,4 +1,4 @@
-handyhelpers/__init__.py,sha256=ywpz4Z6AtaEMPtWFhfvF3pG0zwn1Nhb4kHjbUyP7HbU,406
+handyhelpers/__init__.py,sha256=K3oKhpJJHJk0Dorla4DSbV2WCL9p9ecv3-AB9tgleLM,406
 handyhelpers/apps.py,sha256=g6mXn-5BENf48vY_Qz2FhAABJPBB3EIJXlNM33v6-v8,485
 handyhelpers/checks.py,sha256=8LXb106sIBNV3fNIHDIW-UcixJk8emgbtFkIlKG5ZGM,578
 handyhelpers/context_processors.py,sha256=31-j4WD-xaJp9JU_VbkbyUyWxI2UuDGW9qA805fEGBs,527
@@ -6398,8 +6398,9 @@ handyhelpers/templates/handyhelpers/generic/bs5/partials/pagination_controls.htm
 handyhelpers/templates/handyhelpers/htmx/bs5/about_project_modal_body.htm,sha256=H2OhlHSJObkre_PlkJe_A1ybNAPF2VAVmBtl3HLxmgk,1212
 handyhelpers/templates/handyhelpers/htmx/bs5/generic_modal.htm,sha256=Ttvswnu622audzG5Gl7zikY4KB-4cNcVm6wnWJInZAU,658
 handyhelpers/templates/handyhelpers/htmx/bs5/generic_modal_swap.htm,sha256=NOAScjA1R62Shmrf8uRklRa32LU30nhkopU0ccCjz8c,1826
-handyhelpers/templates/handyhelpers/htmx/bs5/navigation/build_sidebar.htm,sha256=cjRoU4yH3xTsJ40J9mxQ2MdFL0aNdOMyUfO9DgwS8hE,1285
+handyhelpers/templates/handyhelpers/htmx/bs5/navigation/build_sidebar.htm,sha256=6BuqpRbrChQCVHUEzknVd74vxXpyPf2YYMq1e5LawEU,1757
 handyhelpers/templates/handyhelpers/htmx/bs5/navigation/sidebar_menu_sub_items.htm,sha256=-Hc0qxWK_vWCYW8T52NV7yvnvJA4-cfRdS5DaWWvx9k,152
+handyhelpers/templates/handyhelpers/partials/calendar.htm,sha256=4UZMT2CzkoxivpJxNhPshMk6EFb0q_bcZzvQXgRKFzM,5141
 handyhelpers/templates/handyhelpers/report/theme_colors.htm,sha256=Jl31SW6o_2lGctKY2gz9INKFs7REC7FSqLtkqHfLOBY,1164
 handyhelpers/templates/handyhelpers/report/chartjs/annual_progress.html,sha256=M9UISiqHR4HaiMD7f0FXHpOUwfmsgwjA8up1pnkCckU,323
 handyhelpers/templates/handyhelpers/report/chartjs/annual_progress_chart.htm,sha256=HHlHOKsz7-wHPZVDFVil4uYm6caKAj2VoN4kBNs4oQ8,2294
@@ -6426,12 +6427,13 @@ handyhelpers/views/__init__.py,sha256=09jR-Yd1mhJqfzzoW5bNTum-KLI35OASqo7-8FQmKI
 handyhelpers/views/action.py,sha256=bJZ-F5U6fcoTjxRxkYO1p7-Va4nBet4qfbG5J6WpHyI,1229
 handyhelpers/views/ajax.py,sha256=wbBcl7aORR6OXS9eApdWy1aoFNeYLOJJx4repBVTGZQ,936
 handyhelpers/views/auditlog.py,sha256=uwcLUCbmQf7vIKu9QGpt4bNXuKY79TmPxZLC7ICdjvk,1151
+handyhelpers/views/calendar.py,sha256=u3rm8CXYqcFESoNTGUs9Jhi6a8_pcpKCFdIzBYWpISE,3768
 handyhelpers/views/export.py,sha256=45DP5d8L1npo39WqAqYqAnAaNthN5ILyQMIS8WWn85c,3128
 handyhelpers/views/gui.py,sha256=cPGbMu8-dE7MgYleBiPf3YLX_5AsWVtiu1s6MtEDaoo,43358
-handyhelpers/views/htmx.py,sha256=18sKeY92s5VOYZcQzibPkWXPewnF9ciVQlwRw4QyWTw,6029
+handyhelpers/views/htmx.py,sha256=FWjHj7nexoy0W26LKuTi2HAW6ZiiNhHoNbOYY_apwTQ,6071
 handyhelpers/views/report.py,sha256=1khoo_eEmKLszGEP3sRYqBaKeK-ndbMfahDq7SMRnQI,14898
-django_handyhelpers-0.3.18.dist-info/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
-django_handyhelpers-0.3.18.dist-info/METADATA,sha256=8kusHXhvuc1RCLsEFCvskyoal2murU2atmF8iWzVWRg,3327
-django_handyhelpers-0.3.18.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-django_handyhelpers-0.3.18.dist-info/top_level.txt,sha256=qMQVRQqXX1vYNEfuQbwWMu2J-GLo_bfLmF6mtZF5caU,13
-django_handyhelpers-0.3.18.dist-info/RECORD,,
+django_handyhelpers-0.3.20.dist-info/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+django_handyhelpers-0.3.20.dist-info/METADATA,sha256=dVrUNIFPy7rjk5piy5a4yMuy0nIKakvXuZBoZKmsxMs,3327
+django_handyhelpers-0.3.20.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+django_handyhelpers-0.3.20.dist-info/top_level.txt,sha256=qMQVRQqXX1vYNEfuQbwWMu2J-GLo_bfLmF6mtZF5caU,13
+django_handyhelpers-0.3.20.dist-info/RECORD,,

handyhelpers/__init__.py

@@ -7,7 +7,7 @@ A collection of handy utilities to support django operations.
 """
 
 __title__ = 'django-handyhelpers'
-__version__ = '0.3.18'
+__version__ = '0.3.20'
 __author__ = 'David Slusser'
 __email__ = 'dbslusser@gmail.com'
 __license__ = 'GPL-3.0'

handyhelpers/templates/handyhelpers/htmx/bs5/navigation/build_sidebar.htm

@@ -9,6 +9,15 @@ Build dropdown navigations in a sidebar. This is intented to be used with the ha
             {{ item.model_name|title }}
         </a>
         <ul id="{{ item.target_id }}" class="sidebar-dropdown list-unstyled collapse" data-bs-parent="#sidebar">
+            {% if item.list_all_url %}
+            <li class="sidebar-link">
+                {% if item.htmx_link is False %}
+                <a href="{{ item.list_all_url}}" class="sidebar-link ms-4">All {{ item.model_name }}</a>
+                {% else %}
+                <a hx-get="{{ item.list_all_url }}" hx-target="#{{ item.htmx_target }}" class="sidebar-link ms-4">All {{ item.model_name }}</a>
+                {% endif %}
+            </li>
+            {% endif %}
             {% for row in item.queryset %}
             <li class="sidebar-link">
                 {% if item.link %}

handyhelpers/templates/handyhelpers/partials/calendar.htm

@@ -0,0 +1,126 @@
+    
+    <style>
+        /* Add custom styles if needed */
+        /* Customize the calendar container */
+        .calendar-container {
+            margin-top: 1.5rem;
+            margin-bottom: 1.5rem;
+            padding-left: 3rem;
+            padding-right: 3rem;
+        }
+        /* Customize the navigation links */
+        .nav-links {
+            margin-bottom: 10px;
+        }
+        /* Customize the calendar table */
+        .calendar-table {
+            width: 100%;
+            border-collapse: collapse;
+        }
+        .calendar-table th {
+            border: 1px solid #dee2e6;
+            padding: 8px;
+            text-align: center;
+            height: 1rem; /* Set fixed height for header row cells */
+        }
+        .calendar-table td {
+            border: 1px solid #dee2e6;
+            padding: 8px;
+            text-align: center;
+            width: 80px; /* Set fixed width for all cells except header row */
+            height: 80px; /* Set fixed height for all cells except header row */
+        }
+        /* Highlight today's date with a different background color */
+        .today {
+            background-color: var(--bg-light-subtle) !important; /* Change to your desired background color */
+        }
+        /* Styling for events */
+        .event {
+            background-color: #007bff; /* Bootstrap primary color */
+            color: #fff; /* White text color */
+            padding: 4px;
+            border-radius: 4px;
+            margin-top: 2px;
+            font-size: .75rem;
+            margin-left: .75rem;
+            margin-right: .75rem;
+            {% comment %} cursor: pointer; {% endcomment %}
+        }
+        .cursor-pointer{
+            cursor: pointer;
+          }
+    </style>
+    
+    <div class="container-fluid calendar-container">
+        <div class="h2 mt-5 text-primary text-center fw-bold">{{ title }}</div>
+        <div class="h4 mb-3 text-secondary text-center">{{ month_name }} {{ year }}</div>
+        <div class="text-end nav-links">
+            <a 
+            {% if use_htmx %}
+            hx-get="{{ today_url }}" hx-target="#body_main"
+            {% else %}
+            href="{{ today_url }}" 
+            {% endif %}
+            class="me-3" style="text-decoration: none">
+                today
+            </a>
+            <a 
+            {% if use_htmx %}
+            hx-get="{{ prev_month_url }}" hx-target="#body_main"
+            {% else %}
+            href="{{ prev_month_url }}"
+            {% endif %}
+            class="me-2" title="previous month">
+                <i class="fa-solid fa-angle-left"></i>
+            </a>
+            <a 
+            {% if use_htmx %}
+            hx-get="{{ next_month_url }}" hx-target="#body_main"
+            {% else %}
+            href="{{ next_month_url }}"
+            {% endif %}
+            class="ms-2" title="next month">
+                <i class="fa-solid fa-angle-right"></i>
+            </a>
+        </div>
+        <table class="table table-bordered calendar-table shadow">
+            <thead>
+                <tr>
+                    <th class="bg-light-subtle" scope="col">Mon</th>
+                    <th class="bg-light-subtle" scope="col">Tue</th>
+                    <th class="bg-light-subtle" scope="col">Wed</th>
+                    <th class="bg-light-subtle" scope="col">Thu</th>
+                    <th class="bg-light-subtle" scope="col">Fri</th>
+                    <th class="bg-light-subtle" scope="col">Sat</th>
+                    <th class="bg-light-subtle" scope="col">Sun</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for week in cal_data %}
+                    <tr>
+                    {% for day in week %}
+                        <td {% if day == today.day and month == today.month and year == today.year %}class="today"{% endif %}>
+                            {% if day %}
+                            <div class="text-end {% if day == today.day and month == today.month and year == today.year %}fw-bold{% endif %}">{{ day }}</div>
+                            {%endif%}
+                            {% for event in event_list %}
+                                {% if event.date_time.day == day and event.date_time.month == month and event.date_time.year == year %}   
+                                    {% if event_detail_url %}
+                                <div class="event hvr-grow d-block cursor-pointer"
+                                hx-get="{% url event_detail_url event.pk %}"
+                                hx-target="#modal_wrapper"
+                                data-bs-toggle="modal"
+                                data-bs-target="#modal_wrapper">{{ event }}
+                                </div>
+                                    {% else %}
+                                    <div class="event">{{ event }}</div>
+                                    {% endif %}
+                                {% endif %}
+                            {% endfor %}
+                        </td>
+                    {% endfor %}
+                    </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </div>

handyhelpers/views/calendar.py

@@ -0,0 +1,104 @@
+import calendar
+from datetime import date
+import re
+
+from django.shortcuts import render
+from django.views.generic import View
+
+
+
+class CalendarView(View):
+    """ View to render a monthly calendar and optionally display events.
+
+    class parameters:
+        template_name           - template used when rendering partial; defaults to: handyhelpers/partials/calendar.htm
+        event_model             - django model representing events
+        event_model_date_field  - date or datetime field containing event date
+        event_detail_url        - url to use to get event details and display in a modal
+        use_htmx                - boolean representing option to use htmx in in today/next month/previous month links 
+    
+    Usage Example:
+        class MyEventCalendarView(CalendarView):
+            event_model = Event
+            event_model_date_field = "date"
+            event_detail_url = "myapp_:get_event_details"   
+    """
+    title = "Calendar"
+    event_model = None
+    event_model_date_field = None
+    event_detail_url = None
+    template_name = "handyhelpers/partials/calendar.htm"
+    use_htmx = True
+
+    def get_next(self, this_year:int, this_month:int) -> tuple:
+        """get the year and month of the next month
+
+        Args:
+            this_year (int): year of the currently rendered calendar
+            this_month (int): month of the currently rendered calendar
+
+        Returns:
+            tuple: tuple of integers containing year and month of the next calendar month
+        """
+        if this_month == 12:
+            return (this_year + 1), 1
+        return this_year, this_month + 1
+
+    def get_previous(self, this_year:int, this_month:int) -> tuple:
+        """get the year and month of the previous month
+
+        Args:
+            this_year (int): year of the currently rendered calendar
+            this_month (int): month of the currently rendered calendar
+
+        Returns:
+            tuple: tuple of integers containing year and month of the next calendar month
+        """
+        if this_month == 1:
+            return this_year - 1, 12
+        return this_year, this_month - 1
+
+    def get(self, request, *args, **kwargs):
+        mo = re.search(r"^(/[^/]+/)", request.path)
+        if mo:
+            calendar_url_root = mo.groups()[0]
+        
+        today = date.today()
+        year = kwargs.get("year", today.year)
+        month = kwargs.get("month", today.month)
+        if year == 0:
+            year = today.year
+        if month == 0:
+            month = today.month
+        next_year, next_month = self.get_next(year, month)
+        prev_year, prev_month = self.get_previous(year, month)
+
+        today_url = f"{calendar_url_root}{today.year}/{today.month}"
+        prev_month_url = f"{calendar_url_root}{prev_year}/{prev_month}"
+        next_month_url = f"{calendar_url_root}{next_year}/{next_month}"
+        
+        cal_data = calendar.monthcalendar(year, month)
+
+        queryset = None
+        if self.event_model:
+            queryset = self.event_model.objects.filter(
+                **{f"{self.event_model_date_field}__year": year,
+                   f"{self.event_model_date_field}__month": month,
+                   }
+                )
+
+        context = {
+            "cal_data": cal_data,
+            "title": self.title,
+            "year": year,
+            "month": month,
+            "month_name": calendar.month_name[month],
+            "today": today,
+            "event_list": queryset,
+            "use_htmx": self.use_htmx,
+            "event_detail_url": self.event_detail_url,
+            "today_url": today_url,
+            "prev_month_url": prev_month_url,
+            "next_month_url": next_month_url,
+        }
+        return render(request, self.template_name, context)

handyhelpers/views/htmx.py

@@ -123,6 +123,7 @@ class BuildModelSidebarNav(HtmxViewMixin, View):
                 {"queryset": MyModelOne.objects.filter(enabled=True),
                 "icon": '<i class="fa-solid fa-people-group"></i>',
                 "htmx_link": False,
+                "list_all_url": "list_mymodelones",
                 },
             ]
     """
@@ -144,7 +145,7 @@ class BuildModelSidebarNav(HtmxViewMixin, View):
             item["link"] = hasattr(queryset.model, "get_absolute_url")
             if item.get("htmx_link", True) and not item.get("htmx_target", None):
                 item["htmx_target"] = "body_main"
-        self.context = dict(
+        context = dict(
             menu_item_list=self.menu_item_list,
         )
-        return render(request, self.template_name, self.context)
+        return render(request, self.template_name, context)