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.
