django-spire 0.0.1__tar.gz

django_spire-0.0.1/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Stratus Advanced Technologies and Contributors.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

django_spire-0.0.1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: django-spire
+Version: 0.0.1
+Summary: A project for Django Spire
+Home-page: https://github.com/stratusadv/django-spire
+Author: Austin Sauer, Brayden Carlson, Nathan Johnson & Wesley Howery
+Author-email: Brayden Carlson <braydenc@stratusadv.com>, Nathan Johnson <nathanj@stratusadv.com>
+License: Copyright (c) 2024 Stratus Advanced Technologies and Contributors.
+        
+        Permission is hereby granted, free of charge, to any person
+        obtaining a copy of this software and associated documentation
+        files (the "Software"), to deal in the Software without
+        restriction, including without limitation the rights to use,
+        copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the
+        Software is furnished to do so, subject to the following
+        conditions:
+        
+        The above copyright notice and this permission notice shall be
+        included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+        OTHER DEALINGS IN THE SOFTWARE.
+        
+Keywords: portal,cmms
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: django>=5.1.4
+Requires-Dist: django-glue>=0.7.8
+Requires-Dist: dandy>=0.5.2

django_spire-0.0.1/README.rst

@@ -0,0 +1,62 @@
+django-spire
+============
+
+.. image:: https://camo.githubusercontent.com/dbdd84d7f7838316851e62ce34b0066e7cc57abc8f348aaadedc3888819992a9/68747470733a2f2f692e696d6775722e636f6d2f4e736958794f582e706e67
+   :alt: Django Spire Logo
+   :align: center
+
+``django_spire`` is a modular framework designed to enhance observability and improve the development of Django web applications.
+
+Features
+--------
+
+- **Modular Architecture**: Select and install only the modules you need.
+- **Seamless Integration**: Works alongside your existing Django application without intrusive changes.
+- **Customizable & Extensible**: Configure and extend modules to suit specific project requirements.
+
+Getting Started
+---------------
+
+To install ``django_spire``, run:
+
+.. code-block:: bash
+
+    pip install django_spire
+
+Add ``django_spire`` to your Django project’s ``INSTALLED_APPS``:
+
+.. code-block:: python
+
+    INSTALLED_APPS = [
+        'django_spire.ai',
+        'django_spire.core',
+        'django_spire.authentication',
+        'django_spire.authentication.mfa',
+        'django_spire.breadcrumb',
+        'django_spire.comment',
+        'django_spire.core',
+        'django_spire.file',
+        'django_spire.form',
+        'django_spire.gamification',
+        'django_spire.help',
+        'django_spire.history',
+        'django_spire.maintenance',
+        'django_spire.modal',
+        'django_spire.notification',
+        'django_spire.options',
+        'django_spire.pagination',
+        'django_spire.permission',
+        'django_spire.search',
+        'django_spire.user_account',
+        'django_spire.user_account.profile'
+    ]
+
+Documentation
+-------------
+
+Please refer to our documentation for detailed setup, module configuration, and usage examples.
+
+Contributing
+------------
+
+We welcome contributions! See our contributing guide for more details on how to get involved.

django_spire-0.0.1/django_spire/ai/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AIConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'spire_ai'
+    name = 'django_spire.ai'

django_spire-0.0.1/django_spire/ai/urls.py

@@ -0,0 +1,14 @@
+from django.urls import path
+
+from django_spire.ai import views
+
+
+app_name = 'ai'
+
+urlpatterns = [
+    path(
+        'transcribe/',
+        views.transcribe_audio,
+        name='transcribe'
+    )
+]

django_spire-0.0.1/django_spire/ai/views.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+import whisper
+
+from enum import Enum
+from pathlib import Path
+
+from django.core.files.storage import FileSystemStorage
+from django.http import JsonResponse
+from django.views.decorators.csrf import csrf_protect
+
+
+class WhisperModel(Enum):
+    TINY = 'tiny'
+    BASE = 'base'
+    SMALL = 'small'
+    MEDIUM = 'medium'
+    LARGE = 'large'
+    TURBO = 'turbo'
+
+
+model = whisper.load_model(WhisperModel.TINY.value)
+
+
+@csrf_protect
+def transcribe_audio(request):
+    if request.method == 'POST':
+        file = request.FILES.get('audio')
+
+        if not file:
+            return JsonResponse({'error': 'No audio file provided'}, status=400)
+
+        storage = FileSystemStorage()
+        location = storage.save(file.name, file)
+        path = Path(storage.path(location))
+
+        try:
+            result = model.transcribe(str(path))
+            transcription = result['text']
+        except Exception as e:
+            return JsonResponse({'error': str(e)}, status=500)
+        finally:
+            if path.exists():
+                path.unlink()
+
+        return JsonResponse({'transcription': transcription}, status=200)
+
+    return JsonResponse({'error': 'Invalid request method'}, status=405)

django_spire-0.0.1/django_spire/authentication/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AuthenticationConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'spire_authentication'
+    name = 'django_spire.authentication'

django_spire-0.0.1/django_spire/authentication/mfa/admin.py

@@ -0,0 +1,21 @@
+from django.contrib import admin
+from django.urls import reverse
+from django.utils.html import format_html
+
+from django_spire.authentication.mfa import models
+
+
+@admin.register(models.MfaCode)
+class MfaCodeAdmin(admin.ModelAdmin):
+    list_display = (
+        'id', 'user_link', 'code', 'expiration_datetime', 'is_valid'
+    )
+    list_filter = ('expiration_datetime',)
+    search_fields = ('id', 'user__username', 'code')
+    ordering = ('-expiration_datetime',)
+
+    def user_link(self, mfa_code: models.MfaCode) -> str:
+        url = reverse('admin:auth_user_change', args=[mfa_code.user.id])
+        return format_html(f'<a href="{url}">{mfa_code.user.username}</a>')
+
+    user_link.short_description = 'User'

django_spire-0.0.1/django_spire/authentication/mfa/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class MfaConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'spire_authentication_mfa'
+    name = 'django_spire.authentication.mfa'

django_spire-0.0.1/django_spire/authentication/mfa/forms.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from django import forms
+
+from crispy_forms.helper import FormHelper
+from crispy_forms.layout import Layout, Row, Column, HTML
+
+
+class MFAForm(forms.Form):
+    def __init__(self, generated_mfa_code, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.helper = FormHelper(self)
+        self.helper.include_media = False
+        self.generated_mfa_code = generated_mfa_code
+        self.fields['mfa_code'] = forms.CharField(max_length=6, label='Authentication Code')
+
+        self.helper.layout = Layout(
+            Row(
+                Column('mfa_code', css_class='form-group col-12'),
+            ),
+            HTML("{% include 'spire/form/form_submit_button.html' %}")
+        )
+
+    def clean(self) -> None:
+        cleaned_data = super().clean()
+
+        mfa_code = cleaned_data.get('mfa_code')
+
+        if mfa_code != self.generated_mfa_code.code:
+            self.add_error('mfa_code', 'Invalid MFA Code.')

django_spire-0.0.1/django_spire/authentication/mfa/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.3 on 2024-11-08 22:57
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MfaCode',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('code', models.CharField(editable=False, max_length=6, unique=True)),
+                ('expiration_datetime', models.DateTimeField(editable=False)),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='mfa_codes', related_query_name='mfa_code', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'db_table': 'spire_authentication_mfa_code',
+            },
+        ),
+    ]

django_spire-0.0.1/django_spire/authentication/mfa/models.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import random
+
+from dateutil import relativedelta
+
+from django.contrib.auth.models import User
+from django.contrib.sites.models import Site
+from django.db import models
+from django.urls import reverse
+from django.utils.timezone import localtime
+
+from django_spire.notification.sender import SendGridEmailHelper
+from django_spire.authentication.mfa.querysets import MfaCodeQuerySet
+
+
+class MfaCode(models.Model):
+    user = models.ForeignKey(User, on_delete=models.CASCADE, related_query_name='mfa_code', related_name='mfa_codes')
+    code = models.CharField(max_length=6, editable=False, unique=True)
+    expiration_datetime = models.DateTimeField(editable=False)
+
+    objects = MfaCodeQuerySet.as_manager()
+
+    def __str__(self):
+        return f'{self.expiration_datetime} - {self.code}'
+
+    def is_valid(self) -> bool:
+        return self.expiration_datetime > localtime()
+
+    def set_expired(self) -> None:
+        self.expiration_datetime = localtime()
+        self.save()
+
+    def send_notification(self):
+        user = self.user
+
+        context_data = {
+            'title': 'Authentication Code',
+            'body': f"Here is your multifactor authentication code: </br> <h3>{self.code}</h3>",
+            'name': user.first_name,
+            'button_url': f'{Site.objects.get_current()}/{reverse("authentication:redirect:login_redirect")[1:]}'
+        }
+
+        # Directly connecting to SendGrid to send MFA email faster
+        SendGridEmailHelper(
+            to=[user.email],
+            template_id='d-9ae6be6be95d4f79b0daad9055f03cc9',
+            template_data=context_data,
+            fail_silently=False
+        ).send()
+
+    @classmethod
+    def generate_code(cls, user):
+        return MfaCode.objects.create(
+            user=user,
+            code=int(''.join([str(random.randint(0, 9)) for _ in range(6)])),
+            expiration_datetime=localtime() + relativedelta.relativedelta(minutes=5)
+        )
+
+    class Meta:
+        db_table = 'spire_authentication_mfa_code'

django_spire-0.0.1/django_spire/authentication/mfa/querysets.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from django.db.models import QuerySet
+from django.utils.timezone import localtime
+
+
+class MfaCodeQuerySet(QuerySet):
+    def valid_code(self, user):
+        return self.filter(user=user, expiration_datetime__gte=localtime()).first()

django_spire-0.0.1/django_spire/authentication/mfa/urls/__init__.py

@@ -0,0 +1,9 @@
+from django.urls import include, path
+
+
+app_name = '__init__'
+
+urlpatterns  = [
+    path('', include('django_spire.authentication.mfa.urls.page_urls', namespace='page')),
+    path('', include('django_spire.authentication.mfa.urls.redirect_urls', namespace='redirect')),
+]

django_spire-0.0.1/django_spire/authentication/mfa/urls/page_urls.py

@@ -0,0 +1,12 @@
+from django.urls import path
+
+from django_spire.authentication.mfa.views import page_views
+
+
+app_name = 'page'
+
+urlpatterns = [
+    path('form/',
+         page_views.mfa_form_view,
+         name='form'),
+]

django_spire-0.0.1/django_spire/authentication/mfa/urls/redirect_urls.py

@@ -0,0 +1,12 @@
+from django.urls import path
+
+from django_spire.authentication.mfa.views import redirect_views
+
+
+app_name = 'redirect'
+
+urlpatterns = [
+    path('notification/',
+         redirect_views.mfa_notification_redirect_view,
+         name='notification'),
+]

django_spire-0.0.1/django_spire/authentication/mfa/utils.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from typing_extensions import TYPE_CHECKING
+
+from django_spire.authentication.mfa.models import MfaCode
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+
+
+def get_or_generate_user_mfa_code(user: User) -> MfaCode:
+    mfa_code = MfaCode.objects.valid_code(user)
+
+    if mfa_code:
+        return mfa_code
+
+    return MfaCode.generate_code(user)

django_spire-0.0.1/django_spire/authentication/mfa/views/page_views.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from django.contrib import messages
+from django.http import HttpResponseRedirect
+from django.template.response import TemplateResponse
+from django.urls import reverse
+
+from django_spire.authentication.mfa.utils import get_or_generate_user_mfa_code
+from django_spire.authentication.mfa import forms
+
+
+def mfa_form_view(request):
+    mfa_code = get_or_generate_user_mfa_code(request.user)
+    profile = request.user.profile
+
+    if request.method == 'POST':
+        form = forms.MFAForm(mfa_code, request.POST)
+        if form.is_valid():
+            mfa_code.set_expired()
+            profile.set_mfa_grace_period()
+            return HttpResponseRedirect(reverse('home:home'))
+
+        if 'mfa_code' in form.errors:
+            messages.error(request, form.errors['mfa_code'][0])
+
+    context_data = {
+        'form': forms.MFAForm(mfa_code, initial=request.POST),
+        'form_description': 'An authentication code has been sent to your email. Please enter it below to continue.',
+    }
+
+    return TemplateResponse(
+        request,
+        context=context_data,
+        template='spire/authentication/mfa/mfa_form.html'
+    )
+

django_spire-0.0.1/django_spire/authentication/mfa/views/redirect_views.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from django.contrib import messages
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+
+from django_spire.authentication.mfa.utils import get_or_generate_user_mfa_code
+
+
+def mfa_notification_redirect_view(request):
+    mfa_code = get_or_generate_user_mfa_code(request.user)
+
+    if request.GET.get('resend', False):
+        mfa_code.set_expired()
+        mfa_code = get_or_generate_user_mfa_code(request.user)
+
+    mfa_code.send_notification()
+    messages.info(request, 'A authentication code has been sent to your email.')
+
+    return HttpResponseRedirect(reverse('authentication:mfa:page:form'))

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/mfa/mfa_form.html

@@ -0,0 +1,25 @@
+{% extends "spire/page/center_card_page.html" %}
+
+{% load crispy_forms_filters %}
+
+{% load static %}
+
+{% block base_title %}
+    Login
+{% endblock %}
+
+{% block page_center_card_content %}
+    {% include 'spire/notification/notification.html' %}
+
+    {% if form_description %}
+        {% include 'spire/note/info_note.html' with note_type='Note' note_text=form_description %}
+    {% endif %}
+
+    <form method="post">
+         {% csrf_token %}
+        {{ form|crispy }}
+        <button type="submit" class="w-100 btn btn-app-primary mt-2">Submit</button>
+    </form>
+
+    <a class="text-center text-decoration-none" href={% url 'user_account:authentication:mfa:redirect:notification' %}?resend=True>Resend Code?</a>
+{% endblock %}

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/authentication_page.html

@@ -0,0 +1,26 @@
+{% extends 'spire/page/page.html' %}
+
+{% load static %}
+
+{% block page_content %}
+    <div class="row justify-content-center ps-3 mt-5">
+        <div class="col-11 col-md-6 col-lg-4 bg-app-layer-one">
+            <div class="px-4 py-5">
+                {% block authentication_page_top_content %}
+                    <div class="text-center pb-5">
+                        <a href="/">
+                            {% block authentication_page_img %}
+                                <img class="ms-1 img-fluid" src="{% static 'spire/img/stratus_secondary_medium.png' %}"
+                                     alt="">
+                            {% endblock %}
+                        </a>
+                    </div>
+                {% endblock %}
+                {% block authentication_page_content %}
+
+                {% endblock %}
+            </div>
+        </div>
+    </div>
+{% endblock %}
+

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/login_page.html

@@ -0,0 +1,23 @@
+{% extends 'spire/authentication/page/authentication_page.html' %}
+
+{% load crispy_forms_filters %}
+
+{% block authentication_page_content %}
+
+    <form method="post" class="text-app-secondary">
+        {% csrf_token %}
+        {{ form|crispy }}
+        <button type="submit" class="d-block mx-auto btn btn-app-primary-outlined my-4 w-100">Login</button>
+    </form>
+
+    <div class="text-center">
+        <a href="{% url 'authentication:admin:password_reset' %}"
+            class="fs--1 text-app-secondary cursor-pointer">
+            Forgot my password
+        </a>
+    </div>
+
+{% endblock %}
+
+
+

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/logout_page.html

@@ -0,0 +1,23 @@
+{% extends 'spire/page/centered_card_page.html' %}
+
+{% load crispy_forms_filters static %}
+
+{% block page_card_content %}
+    <div class="row">
+        <div class="col-12">
+            <div class="d-flex justify-content-center align-items-end my-2">
+                <img height="70px" src="" alt="Logo Here">
+                <div class="h4">Application Logout</div>
+
+            </div>
+            <hr class="mt-0">
+        </div>
+        <div class="col px-4">
+            <form method="post" action="{% url 'authentication:redirect:logout' %}">
+                {% csrf_token %}
+                {{ form|crispy }}
+                <button type="submit" class="d-block mx-auto bg-light-primary shadow-sm text-white btn my-4 w-100">Logout</button>
+            </form>
+        </div>
+    </div>
+{% endblock %}

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/password_change_done_page.html

@@ -0,0 +1,12 @@
+{% extends 'spire/authentication/page/authentication_page.html' %}
+
+{% load static %}
+{% load crispy_forms_filters %}
+
+{% block base_title %}Password Changed Successfully{% endblock %}
+
+{% block authentication_page_content %}
+    <h3>Password Reset</h3>
+    <div class="py-2">You have successfully changed your password!</div>
+    <a class="w-100 btn btn-app-primary bg-app-primary mt-2" href="{% url 'home:home' %}">Home</a>
+{% endblock %}

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/password_change_page.html

@@ -0,0 +1,14 @@
+{% extends 'spire/authentication/page/authentication_page.html' %}
+
+{% load crispy_forms_filters %}
+
+{% block authentication_page_content %}
+    <h5 class="mb-2">Change Password</h5>
+    <div>
+        <form method="post">
+            {% csrf_token %}
+            {{ form|crispy }}
+            <button type="submit" class="w-100 btn btn-app-primary bg-app-primary mt-2">Submit</button>
+        </form>
+    </div>
+{% endblock %}

django_spire-0.0.1/django_spire/authentication/templates/spire/authentication/page/password_reset_complete_page.html

@@ -0,0 +1,10 @@
+{% extends 'spire/authentication/page/authentication_page.html' %}
+
+{% load static %}
+
+{% block base_title %}Password Reset Complete{% endblock %}
+
+{% block authentication_page_content %}
+    <h3>Password Reset Complete</h3>
+    <div>Your new password has been set. You can log in now on the <a href="{% url 'user_account:authentication:admin:login' %}">log in page</a>.</div>
+{% endblock %}