Installation
============

Requirements
------------

-  Django 4.2
-  Python 3.8 - 3.10

Installing
----------

1. Install the app

   .. code-block:: sh

       $ pip install major-event-log

2. Add app and all dependencies to INSTALLED\_APPS.

   .. code-block:: python

       INSTALLED_APPS = (
         'django.contrib.admin',
         'django.contrib.auth',
         'django.contrib.contenttypes',
         'django.contrib.sessions',
         'django.contrib.messages',
         'django.contrib.staticfiles',
         'major_event_log',
       )

3. Include the URLs

   .. code-block:: python

       urlpatterns = [
         path('admin/', admin.site.urls),
         path('major-event-log/', include(('major_event_log.urls', 'major-event-log'),
             namespace="major-event-log"))
       ]

4. Migrate/sync the database

   .. code-block:: sh

       $ python manage.py migrate