Metadata-Version: 2.3
Name: django_request_approval
Version: 1.0.0
Summary: Django Request Approval Process
Project-URL: Homepage, https://github.com/briansimpo/django-request-approval
Project-URL: Issues, https://github.com/briansimpo/django-request-approval/issues
Author-email: Brian Simpokolwe <briansimpokolwe@gmail.com>
Keywords: approval,django approval
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Requires-Dist: django-model-utils>=4.5.1
Requires-Dist: django>=4.0.0
Description-Content-Type: text/markdown


# Django Request Approval

This is a package of base classes for approval process. 
To use this package, you have to create classes that inherit base classes from this package.
Detailed documentation is in the "docs" directory.

## Quick start

1. Add `django_request_approval` to your INSTALLED_APPS setting like this::

```python 

    INSTALLED_APPS = [
        ...,
        "django_request_approval",
    ]

```

## Usage


### List of Base classes

The package contains 4 base classes
1. BaseStage -> Represents Approval Stages (Stage 1, Stage 2, Stage 3)
2. BaseApprover -> Represents Stage Approver (Stage, User Group)
3. BaseRequest -> Represents the Request to be approved
4. BaseApproval -> Represents the actual Approval made by Approver


