django-spire 0.24.3__tar.gz → 0.25.0__tar.gz

{django_spire-0.24.3 → django_spire-0.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.24.3
+Version: 0.25.0
 Summary: A project for Django Spire
 Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
 License: Copyright (c) 2025 Stratus Advanced Technologies and Contributors.
@@ -52,7 +52,7 @@ Requires-Dist: crispy-bootstrap5==2024.10
 Requires-Dist: dandy>=1.3.5
 Requires-Dist: django>=5.1.8
 Requires-Dist: django-crispy-forms==2.3
-Requires-Dist: django-glue>=0.8.1
+Requires-Dist: django-glue>=0.8.12
 Requires-Dist: django-sendgrid-v5
 Requires-Dist: django-storages==1.14.5
 Requires-Dist: docutils

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/consts.py

@@ -1,4 +1,4 @@
-__VERSION__ = '0.24.3'
+__VERSION__ = '0.25.0'
 
 MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
 

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/core/static/django_spire/css/app-printing.css

@@ -1,4 +1,29 @@
+.fs-print-1 {
+    font-size: 1.0rem !important;
+}
+
+.fs-print-2 {
+    font-size: 0.90rem !important;
+}
+
+.fs-print-3 {
+    font-size: 0.70rem !important;
+}
+
 @media print {
+
+    .fs-print-1 {
+        font-size: .80rem !important;
+    }
+
+    .fs-print-2 {
+        font-size: .70rem !important;
+    }
+
+    .fs-print-3 {
+        font-size: .55rem !important;
+    }
+
     .hide-on-print {
         display: none !important;
     }

django_spire-0.25.0/django_spire/metric/report/__init__.py

@@ -0,0 +1,7 @@
+from django_spire.metric.report.report import BaseReport
+from django_spire.metric.report.registry import ReportRegistry
+
+__all__ = [
+    'BaseReport',
+    'ReportRegistry',
+]

django_spire-0.25.0/django_spire/metric/report/helper.py

@@ -0,0 +1,92 @@
+import calendar
+from datetime import datetime, timedelta
+
+from django.utils.timezone import now
+
+
+class Helper:
+    @property
+    def thirty_days_ago(self) -> datetime:
+        return self.today - timedelta(days=30)
+
+    @property
+    def sixty_days_ago(self) -> datetime:
+        return self.today - timedelta(days=60)
+
+    @property
+    def ninety_days_ago(self) -> datetime:
+        return self.today - timedelta(days=90)
+
+    @property
+    def today(self) -> datetime:
+        return now()
+
+    @property
+    def tomorrow(self) -> datetime:
+        return self.today + timedelta(days=1)
+
+    @property
+    def yesterday(self) -> datetime:
+        return self.today - timedelta(days=1)
+
+    @property
+    def start_of_current_week(self) -> datetime:
+        return self.today - timedelta(days=self.today.weekday())
+
+    @property
+    def end_of_current_week(self) -> datetime:
+        return self.start_of_week + timedelta(days=6)
+
+    @property
+    def start_of_last_week(self) -> datetime:
+        return self.start_of_week - timedelta(days=6)
+
+    @property
+    def end_of_last_week(self) -> datetime:
+        return self.end_of_week - timedelta(days=6)
+
+    @property
+    def start_of_current_month(self) -> datetime:
+        return self.today.replace(day=1)
+
+    @property
+    def end_of_current_month(self) -> datetime:
+        _, last_day = calendar.monthrange(self.today.year, self.today.month)
+        return self.today.replace(day=last_day)
+
+    @property
+    def start_of_last_month(self) -> datetime:
+        return self._add_months(self.today, -1).replace(day=1)
+
+    @property
+    def end_of_last_month(self) -> datetime:
+        last_month = self._add_months(self.today, -1)
+        _, last_day = calendar.monthrange(last_month.year, last_month.month)
+
+        return last_month.replace(day=last_day)
+
+    @property
+    def start_of_current_year(self) -> datetime:
+        return self.today.replace(month=1, day=1)
+
+    @property
+    def end_of_current_year(self) -> datetime:
+        return self.today.replace(month=12, day=31)
+
+    @property
+    def start_of_last_year(self) -> datetime:
+        return self.today.replace(year=self.today.year - 1, month=1, day=1)
+
+    @property
+    def end_of_last_year(self) -> datetime:
+        return self.today.replace(year=self.today.year - 1, month=12, day=31)
+
+    @staticmethod
+    def _add_months(datetime_, months):
+        month = datetime_.month - 1 + months
+        year = datetime_.year + month // 12
+        month = month % 12 + 1
+
+        day = min(datetime_.day, calendar.monthrange(year, month)[1])
+
+        return datetime_.replace(year=year, month=month, day=day)

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/metric/report/report.py

@@ -5,6 +5,7 @@ from dataclasses import field
 from typing import Literal, Callable, Any
 
 from django_spire.metric.report.enums import ColumnType
+from django_spire.metric.report.helper import Helper
 from django_spire.metric.report.tools import get_text_alignment_css_class
 
 ColumnLiteralType = Literal['text', 'choice', 'number', 'dollar', 'percent']
@@ -31,27 +32,28 @@ class ReportCell:
     def css_class(self) -> str:
         return get_text_alignment_css_class(self.type)
 
-    def cell_value_verbose(self, value):
-        if self.type == ColumnType.DOLLAR:
+    @staticmethod
+    def cell_value_verbose(value, cell_type):
+        if cell_type == ColumnType.DOLLAR:
             return f"${float(value):,.2f}"
-        elif self.type == ColumnType.NUMBER:
+        elif cell_type == ColumnType.NUMBER:
             return f"{float(value):,.0f}"
-        elif self.type == ColumnType.PERCENT:
+        elif cell_type == ColumnType.PERCENT:
             return f"{float(value):.1f}%"
-        elif self.type == ColumnType.DECIMAL_1:
+        elif cell_type == ColumnType.DECIMAL_1:
             return f"{float(value):.1f}"
-        elif self.type == ColumnType.DECIMAL_2:
+        elif cell_type == ColumnType.DECIMAL_2:
             return f"{float(value):.2f}"
-        elif self.type == ColumnType.DECIMAL_3:
+        elif cell_type == ColumnType.DECIMAL_3:
             return f"{float(value):.3f}"
 
         return str(value)
 
     def value_verbose(self):
-        return self.cell_value_verbose(self.value)
+        return self.cell_value_verbose(self.value, self.type)
 
     def sub_value_verbose(self):
-        return self.cell_value_verbose(self.sub_value)
+        return self.cell_value_verbose(self.sub_value, self.sub_type)
 
 
 @dataclass
@@ -61,6 +63,8 @@ class ReportRow:
     page_break: bool = False
     span_all_columns: bool = False
     table_break: bool = False
+    border_top: bool = False
+    border_bottom: bool = False
 
 
 class BaseReport(ABC):
@@ -68,6 +72,7 @@ class BaseReport(ABC):
     description: str | None = None
     is_financially_accurate: bool = False
     ColumnType: type[ColumnType] = ColumnType
+    helper: Helper = Helper()
 
     def __init__(self):
         if not self.title:
@@ -97,8 +102,15 @@ class BaseReport(ABC):
             choices_method = getattr(self, f'{name}_choices', None)
 
             if choices_method and isinstance(choices_method, Callable):
-                arguments[name]['choices'] = choices_method()
-                arguments[name]['annotation'] = 'select'
+                choices = tuple(choices_method())
+
+                self.validate_choices(tuple(choices))
+
+                arguments[name]['choices'] = choices
+                if param.annotation.__name__ == 'list':
+                    arguments[name]['annotation'] = 'multi_select'
+                else:
+                    arguments[name]['annotation'] = 'select'
             else:
                 arguments[name]['annotation'] = param.annotation.__name__
 
@@ -108,10 +120,21 @@ class BaseReport(ABC):
     def run(self, **kwargs: Any):
         raise NotImplementedError
 
-    def add_blank_row(self):
+    def add_blank_row(
+            self,
+            text: str = '',
+            page_break: bool = False,
+            border_top: bool = False,
+            border_bottom: bool = False
+    ):
         self.add_row(
-            cell_values=[' '],
+            cell_values=[
+                text
+            ],
             span_all_columns=True,
+            page_break=page_break,
+            border_top=border_top,
+            border_bottom=border_bottom,
         )
 
     def add_column(
@@ -129,24 +152,30 @@ class BaseReport(ABC):
     def add_divider_row(
             self,
             title: str,
+            description: str | None = None,
             page_break: bool = False,
+            border_bottom: bool = True,
     ):
         self.add_row(
             cell_values=[title],
+            cell_sub_values=[description] if description else None,
             bold=True,
             page_break=page_break,
             span_all_columns=True,
+            border_bottom=border_bottom,
         )
 
     def add_footer_row(
             self,
             cell_values: list[Any],
             cell_sub_values: list[Any] | None = None,
+            border_top: bool = True,
     ):
         self.add_row(
             cell_values=cell_values,
             cell_sub_values=cell_sub_values,
             bold=True,
+            border_top=border_top,
         )
 
     def add_row(
@@ -157,6 +186,8 @@ class BaseReport(ABC):
             page_break: bool = False,
             span_all_columns: bool = False,
             table_break: bool = False,
+            border_top: bool = False,
+            border_bottom: bool = False,
     ):
         if span_all_columns or table_break:
             if len(cell_values) > 1:
@@ -183,5 +214,40 @@ class BaseReport(ABC):
                 page_break=page_break,
                 span_all_columns=span_all_columns,
                 table_break=table_break,
+                border_top=border_top,
+                border_bottom=border_bottom,
             )
         )
+
+    @staticmethod
+    def validate_choices(choices: tuple):
+        if not isinstance(choices, tuple):
+            raise TypeError(f'choices must be a tuple not {type(choices)}')
+        if not all(isinstance(item, tuple) and len(item) == 2 for item in choices):
+            raise ValueError('choices must contain tuples of length 2')
+
+    def to_markdown(self) -> str:
+        markdown = ''
+
+        for column in self.columns:
+            markdown += f'| {column.title} '
+
+        markdown += '|\n'
+
+        for column in self.columns:
+            markdown += '| ' + '-' * len(column.title) + ' '
+
+        markdown += '|\n'
+
+        for row in self.rows:
+            if row.span_all_columns:
+                markdown += f'| {row.cells[0].value}' + '|' * len(self.columns) + '\n'
+                continue
+
+            else:
+                for cell in row.cells:
+                    markdown += f'| {cell.value_verbose()} '
+
+            markdown += '|\n'
+
+        return markdown

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/metric/report/templates/django_spire/metric/report/form/report_form.html

@@ -4,7 +4,7 @@
     <div class="col-11 col-md-10 col-lg-8 col-xl-6 mx-auto my-3">
 
         <div class="row">
-            <div class="col fs-5 text-center">
+            <div class="col h5 text-center text-app-primary">
                 {{ report.title }}
             </div>
         </div>
@@ -23,12 +23,19 @@
 
             {% for argument, params in report_run_arguments.items %}
                 <div class="row">
-                    <div class="col mb-2">
-
+                    <div class="col">
                         <label class="form-label">
-                            {{ argument|underscores_to_spaces|title }}
+                            {{ argument|underscores_to_spaces|title }} <span class="text-danger">*</span>
                         </label>
-                        {% if params.annotation == 'str' %}
+                    </div>
+                </div>
+                <div class="row">
+                    <div class="col mb-2 ps-4">
+                        {% if params.annotation == 'date' %}
+                            <input class="form-control" type="date" name="{{ argument }}" value="{{ params.default|date:'Y-m-d' }}">
+                        {% elif params.annotation == 'datetime' %}
+                            <input class="form-control" type="datetime-local" name="{{ argument }}" value="{{ params.default|date:'Y-m-d\\TH:i:s' }}">
+                        {% elif params.annotation == 'str' %}
                             <input class="form-control" type="text" name="{{ argument }}" value="{{ params.default }}">
                         {% elif params.annotation == 'int' %}
                             <input class="form-control" type="number" name="{{ argument }}"
@@ -37,22 +44,37 @@
                             <input class="form-control" type="number" name="{{ argument }}"
                                    value="{{ params.default }}">
                         {% elif params.annotation == 'bool' %}
-                            <br><input class="form-check-input" type="checkbox" name="{{ argument }}"
-                                       value="{{ params.default }}">
+                            <div class="form-check form-switch">
+                                <input class="form-check-input" type="checkbox" role="switch" {% if params.default %}checked{% endif %} id="flexSwitchCheckDefault">
+                            </div>
+                        {% elif params.annotation == 'multi_select' %}
+                            <select class="form-select" multiple size="8" name="{{ argument }}" aria-selected="{{ params.default }}">
+                                {% for key, val in params.choices %}
+                                    <option value="{{ key }}">{{ val }}</option>
+                                {% endfor %}
+                            </select>
                         {% elif params.annotation == 'select' %}
                             <select class="form-select" name="{{ argument }}" aria-selected="{{ params.default }}">
                                 {% for key, val in params.choices %}
                                     <option value="{{ key }}">{{ val }}</option>
                                 {% endfor %}
                             </select>
+                        {% else %}
+                            <br>
+                            <span class="text-danger">Unsupported parameter type: {{ params.annotation }}</span>
                         {% endif %}
                     </div>
                 </div>
             {% endfor %}
 
-            <div class="row">
-                <div class="col mt-3 text-center">
-                    <input class="btn btn-primary" type="submit" value="Run Report">
+            <div x-data="{
+                loading: false
+            }" class="row">
+                <div class="col mt-3 text-center" x-show="!loading">
+                    <input class="btn btn-app-primary" @click="loading = true" type="submit" value="Run Report">
+                </div>
+                <div class="col mt-3 text-center text-app-primary" x-show="loading">
+                    <span class="spinner-border" role="status" aria-hidden="true"></span>
                 </div>
             </div>
             <div class="row">

django_spire-0.25.0/django_spire/metric/report/templates/django_spire/metric/report/print/report_print.html

@@ -0,0 +1,86 @@
+{% load string_formating %}
+
+<div class="row mb-1 font-monospace">
+    <div class="col">
+        <div class="h5 fw-bold">
+            {{ report.title }}
+        </div>
+    </div>
+</div>
+
+<div class="row mx-0 mb-3 text-muted fw-normal fs-print-2 border font-monospace">
+    {% if report.description %}
+        <div class="col-auto ps-1 pe-3">
+            Description: <span class="fw-bold">{{ report.description }}</span>
+        </div>
+    {% endif %}
+    <div class="col-auto ps-1 pe-3">
+        Printed On: <span class="fw-bold">{% now "D, M j, Y" %} at {% now "g:i A" %}</span>
+    </div>
+    <div class="col-auto ps-1 pe-3">
+        Financially Accurate: <span class="fw-bold">{% if report.is_financially_accurate %}True{% else %}False{% endif %}</span>
+    </div>
+    {% for argument, value in report_run_arguments_values.items %}
+        <div class="col-auto ps-1 pe-3">
+            {{ argument|underscores_to_spaces|title }}: <span class="fw-bold">{{ value }}</span>
+        </div>
+    {% endfor %}
+</div>
+
+<div class="row">
+    <div class="col fs-print-2">
+
+        <table class="table table-sm table-hover table-print align-middle">
+            <thead>
+            {% for column in report.columns %}
+                <th class="align-text-top {{ column.css_class }}" style="border-bottom-width: 4px;">
+                    {{ column.title }}
+                    {% if column.sub_title %}
+                        <span class="text-muted fw-normal fs-print-3">
+                            <br>{{ column.sub_title }}
+                        </span>
+                    {% endif %}
+                </th>
+            {% endfor %}
+            </thead>
+            <tbody>
+            {% for row in report.rows %}
+                {% if row.page_break %}
+                    <tr style="page-break-before: always;"></tr>
+                {% endif %}
+                <tr class="{% if row.bold %}fw-bold{% endif %}"
+                    style="{% if row.border_top %}border-top-width: 4px;{% endif %}{% if row.border_bottom %}border-bottom-width: 4px;{% endif %}">
+                    {% if row.span_all_columns %}
+                        <td colspan="{{ report.column_count }}">
+                            {% for cell in row.cells %}
+                                {% if cell.value %}
+                                    {{ cell.value }}
+                                {% else %}
+                                    &nbsp;
+                                {% endif %}
+                                {% if cell.sub_value %}
+                                    <span class="text-muted fw-normal fs-print-3">
+                                        <br>{{ cell.sub_value_verbose }}
+                                    </span>
+                                {% endif %}
+                            {% endfor %}
+                        </td>
+                    {% else %}
+                        {% for cell in row.cells %}
+                            <td class="{{ cell.css_class }}">
+                                {{ cell.value_verbose }}
+                                {% if cell.sub_value %}
+                                    <span class="text-muted fw-normal fs-print-3">
+                                        <br>{{ cell.sub_value_verbose }}
+                                    </span>
+                                {% endif %}
+                            </td>
+                        {% endfor %}
+                    {% endif %}
+                </tr>
+            {% endfor %}
+            </tbody>
+        </table>
+
+    </div>
+</div>

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/metric/report/tools.py

@@ -1,3 +1,5 @@
+import datetime
+
 from django_spire.metric.report.enums import ColumnType
 
 

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire/metric/report/views/page_views.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from datetime import datetime
 from typing import TYPE_CHECKING
 
 from django.conf import settings
@@ -37,9 +38,9 @@ def report_view(request: WSGIRequest) -> TemplateResponse:
             report_registry_class()
         )
 
-    context_data = {
-        'registry': page_report_registry,
-    }
+    context_data = dict()
+
+    context_data['registry'] = page_report_registry
 
     if request.GET:
         report_key_stack = request.GET.get('report_key_stack', None)
@@ -57,9 +58,30 @@ def report_view(request: WSGIRequest) -> TemplateResponse:
 
                 context_data['report_run_arguments_values'] = {}
 
-                for argument in report.run_arguments:
+                for argument in context_data['report_run_arguments']:
                     if context_data['report_run_arguments'][argument]['annotation'] == 'bool':
                         get_request_value = request.GET.get(argument, False)
+
+                    elif context_data['report_run_arguments'][argument]['annotation'] == 'date':
+                        date_str = request.GET.get(argument, None)
+
+                        if date_str:
+                            get_request_value = datetime.strptime(date_str, '%Y-%m-%d').date()
+                        else:
+                            get_request_value = date_str
+
+
+                    elif context_data['report_run_arguments'][argument]['annotation'] == 'datetime':
+                        datetime_str = request.GET.get(argument, None)
+
+                        if datetime_str:
+                            get_request_value = datetime.strptime(datetime_str, '%Y-%m-%dT%H:%M:%S')
+                        else:
+                            get_request_value = datetime_str
+
+                    elif context_data['report_run_arguments'][argument]['annotation'] == 'multi_select':
+                        get_request_value = request.GET.getlist(argument, [])
+
                     else:
                         get_request_value = request.GET.get(argument, None)
 
@@ -73,7 +95,7 @@ def report_view(request: WSGIRequest) -> TemplateResponse:
                         ReportRun.objects.create(
                             report_key_stack=report_key_stack,
                         )
-                        report.run()
+                        report.run(**context_data['report_run_arguments_values'])
 
                 context_data['report'] = report
                 context_data['report_run_count'] = ReportRun.objects.run_count(report_key_stack)

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-spire
-Version: 0.24.3
+Version: 0.25.0
 Summary: A project for Django Spire
 Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
 License: Copyright (c) 2025 Stratus Advanced Technologies and Contributors.
@@ -52,7 +52,7 @@ Requires-Dist: crispy-bootstrap5==2024.10
 Requires-Dist: dandy>=1.3.5
 Requires-Dist: django>=5.1.8
 Requires-Dist: django-crispy-forms==2.3
-Requires-Dist: django-glue>=0.8.1
+Requires-Dist: django-glue>=0.8.12
 Requires-Dist: django-sendgrid-v5
 Requires-Dist: django-storages==1.14.5
 Requires-Dist: docutils

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire.egg-info/SOURCES.txt

@@ -1189,6 +1189,7 @@ django_spire/metric/report/__init__.py
 django_spire/metric/report/admin.py
 django_spire/metric/report/apps.py
 django_spire/metric/report/enums.py
+django_spire/metric/report/helper.py
 django_spire/metric/report/models.py
 django_spire/metric/report/querysets.py
 django_spire/metric/report/registry.py

{django_spire-0.24.3 → django_spire-0.25.0}/django_spire.egg-info/requires.txt

@@ -5,7 +5,7 @@ crispy-bootstrap5==2024.10
 dandy>=1.3.5
 django>=5.1.8
 django-crispy-forms==2.3
-django-glue>=0.8.1
+django-glue>=0.8.12
 django-sendgrid-v5
 django-storages==1.14.5
 docutils

{django_spire-0.24.3 → django_spire-0.25.0}/pyproject.toml

@@ -45,7 +45,7 @@ dependencies = [
     "dandy>=1.3.5",
     "django>=5.1.8",
     "django-crispy-forms==2.3",
-    "django-glue>=0.8.1",
+    "django-glue>=0.8.12",
     "django-sendgrid-v5",
     "django-storages==1.14.5",
     "docutils",