Metadata-Version: 2.2
Name: django-spire
Version: 0.1.32
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.10
Description-Content-Type: text/x-rst
License-File: LICENSE.md
Requires-Dist: django-glue>=0.7.7
Requires-Dist: crispy-bootstrap5>=0.6
Requires-Dist: docutils
Requires-Dist: dandy>=0.9.2
Requires-Dist: django>=5.0.2
Requires-Dist: django-crispy-forms>=1.14.0
Requires-Dist: Pygments
Requires-Dist: psycopg2>=2.9.10
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: typing_extensions

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.
