django-spire 0.23.4__py3-none-any.whl

django_spire/theme/views/page_views.py

@@ -0,0 +1,132 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import login_required
+from django.urls import reverse
+
+from django_spire.contrib import Breadcrumbs
+from django_spire.contrib.generic_views import portal_views
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
+
+@login_required()
+def dashboard_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Dashboard',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/dashboard_page.html'
+    )
+
+
+@login_required()
+def colors_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Colors')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Colors',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/colors_page.html'
+    )
+
+
+@login_required()
+def django_glue_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Django Glue')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Django Glue',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/django_glue_page.html'
+    )
+
+
+@login_required()
+def example_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Core Templates')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Core Templates',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/example/page/example_page.html'
+    )
+
+
+@login_required()
+def typography_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Typography')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Typography',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/typography_page.html'
+    )
+
+
+@login_required()
+def buttons_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Buttons')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Buttons',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/buttons_page.html'
+    )
+
+
+@login_required()
+def badges_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Badges')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Badges',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/badges_page.html'
+    )
+
+
+@login_required()
+def borders_view(request: WSGIRequest) -> TemplateResponse:
+    crumbs = Breadcrumbs()
+    crumbs.add_breadcrumb('Dashboard', reverse('django_spire:theme:page:dashboard'))
+    crumbs.add_breadcrumb('Borders')
+
+    return portal_views.template_view(
+        request,
+        page_title='Theme',
+        page_description='Borders',
+        breadcrumbs=crumbs,
+        template='django_spire/theme/page/borders_page.html'
+    )

django_spire/urls.py

@@ -0,0 +1,21 @@
+from django.apps import apps
+from django.urls import path, include
+
+app_name = 'django_spire'
+
+urlpatterns = []
+
+for app_config in apps.get_app_configs():
+    if hasattr(app_config, 'URLPATTERNS_INCLUDE') and hasattr(app_config, 'URLPATTERNS_NAMESPACE'):
+        urlpatterns.append(
+            path(
+                f'{app_config.URLPATTERNS_NAMESPACE}/',
+                include(
+                    app_config.URLPATTERNS_INCLUDE,
+                    namespace=app_config.URLPATTERNS_NAMESPACE,
+                )
+            ),
+        )
+
+if len(urlpatterns) == 0:
+    raise Exception('You need to have at least one app installed to use Django Spire.')

django_spire/utils.py

@@ -0,0 +1,31 @@
+from django.apps import apps
+
+
+def app_is_installed(app_label: str) -> bool:
+    return app_label in list(apps.app_configs.keys())
+
+
+def check_required_apps(app_label: str) -> None:
+    app_config = apps.get_app_config(app_label)
+    for required_app_name in app_config.REQUIRED_APPS:
+        if not app_is_installed(required_app_name):
+            raise Exception(
+                f"{app_label} requires {required_app_name} is be in the 'INSTALLED_APPS' list before {app_label} in the django settings module.")
+
+
+def get_class_from_string(class_string: str) -> type:
+    class_parts = class_string.split('.')
+
+    if len(class_parts) < 2:
+        raise Exception(f"Class string {class_string} is not a valid class string.")
+
+    module_path = '.'.join(class_parts[:-1])
+    class_name = class_parts[-1]
+
+    module = __import__(module_path, fromlist=[class_name])
+
+    return getattr(module, class_name)
+
+
+def get_class_name_from_class(cls: type) -> str:
+    return cls.__module__ + '.' + cls.__qualname__

django_spire-0.23.4.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: django-spire
+Version: 0.23.4
+Summary: A project for Django Spire
+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,spire,django,backend,frontend,javascript,active server pages
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: beautifulsoup4>=4.14.2
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: botocore>=1.34.0
+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-sendgrid-v5
+Requires-Dist: django-storages==1.14.5
+Requires-Dist: docutils
+Requires-Dist: faker
+Requires-Dist: marko==2.1.4
+Requires-Dist: markitdown[docx,pdf]==0.1.2
+Requires-Dist: psycopg2
+Requires-Dist: pydantic
+Requires-Dist: Pygments
+Requires-Dist: Pillow==11.2.1
+Requires-Dist: python-dateutil
+Requires-Dist: robit>=0.4.8
+Requires-Dist: typing_extensions
+Requires-Dist: twilio
+Provides-Extra: development
+Requires-Dist: build; extra == "development"
+Requires-Dist: django-browser-reload; extra == "development"
+Requires-Dist: django-debug-toolbar; extra == "development"
+Requires-Dist: django-watchfiles; extra == "development"
+Requires-Dist: pip; extra == "development"
+Requires-Dist: playwright; extra == "development"
+Requires-Dist: pyinstrument; extra == "development"
+Requires-Dist: pyrefly; extra == "development"
+Requires-Dist: pytest; extra == "development"
+Requires-Dist: pytest-django; extra == "development"
+Requires-Dist: pytest-playwright; extra == "development"
+Requires-Dist: setuptools; extra == "development"
+Requires-Dist: twine; extra == "development"
+Provides-Extra: documentation
+Requires-Dist: mkdocs; extra == "documentation"
+Requires-Dist: markdown-exec[ansi]; extra == "documentation"
+Requires-Dist: mkdocs-include-markdown-plugin; extra == "documentation"
+Requires-Dist: mkdocs-material; extra == "documentation"
+Requires-Dist: mkdocs-table-reader-plugin; extra == "documentation"
+Requires-Dist: mkdocstrings-python; extra == "documentation"
+Requires-Dist: mkdocs-gen-files; extra == "documentation"
+Requires-Dist: mkdocs-literate-nav; extra == "documentation"
+Requires-Dist: mkdocs-section-index; extra == "documentation"
+Requires-Dist: openpyxl; extra == "documentation"
+Dynamic: license-file
+
+# Django Spire
+
+![Build](https://img.shields.io/github/actions/workflow/status/stratusadv/django-spire/ci.yml)
+![Python Versions](https://img.shields.io/pypi/pyversions/django-spire)
+![PyPI Version](https://img.shields.io/pypi/v/django-spire)
+![Downloads](https://img.shields.io/pypi/dm/django-spire)
+
+## Purpose
+
+Make Django application development modular, extensible, and configurable.
+
+## Getting Started
+
+Please refer to our [website](https://django-spire.stratusadv.com) for detailed setup, module configuration, and usage examples.
+
+<p align="center">
+    <a href="https://django-spire.stratusadv.com">
+        <img alt="Dandy Logo" src="https://django-spire.stratusadv.com/static/img/django_spire_logo_512.png"/>
+    </a>
+</p>