django-ticket

Ticket application for django project

Repository

You can find the source code and contribute to the project at the following link:

GitHub Repository

Contributors

• Abbas Ebadian - Founder of the project
• Hossein Sayyedmousavi - Primary Developer and Contributorand Contributor

Installation

1. install package

pip install django-ticket

2. add this application in settings.INSTALLED_APPS :

INSTALLED_APPS = [
    # ...
    'ticket',
    # ...
]

3. create and migrate migrations in BASE_DIR:

python manage.py migrate ticket

4. in core application include application urls:

from django.urls import path , include

urlpatterns += path("ticket/", include("ticket.urls"))

when you pass this missions you will see this in your admin panel:

API Documentation:

You can create a Ticket from admin panel for a user to admin. Note that and you can do all this operations from admin to a user

/ticket/

Create a ticket from user to admin and add a new message:

method: POST

required keywords : ("title","section","priority","message")

/ticket/

Get all tickets of user as a list

method: GET

required keywords : just must to be authorized.

/ticket/id/

Add message to a ticket with its id :

method: POST

required keywords : ("message",)

Note: id means ticket's id

/ticket/id/

Get a specific ticket by detail with its messages by it's id and Change ticket to seen state from user

method: GET

required keywords : just must to be authorized.

Note: id means ticket's id

/ticket/id/

Close ticket.

method: PATCH

required keywords : just must to be authorized.

Note: id means ticket's id

A little more Professional

You can filter and have not seen tickets in admin panel:

settings.py:

1. Add 'ticket/templates' to DIRS of TEMPLATES:

TEMPLATES = [
    {
        # ...
        'DIRS': [
            # ...
            'ticket/templates'
            # ...
                    ],
        # ...
    }
]

2.Add 'ticket.context_processors.get_pending_tickets' to context_processors OPTIONS:

TEMPLATES = [
    # ...
            "OPTIONS": {
            # ...
            "context_processors": [
                # ...
            'ticket.context_processors.get_pending_tickets'
                # ...
            ]
            # ...
    }
]

Finally your application is complete to use:

Let's enjoy!

Changelog

[Version 3.1.1] - 2024-10-29

Added

• soft_delete attribute ticket and messages.
• viewed attribute view time of a message.
• viewer attribute viewer user of a message.
• swagger api docs and schemas.

Changed

• Make urls RESTFUL. just one address -> /ticket/

Deprecated

• See ticket with an endpoint. seen_by_user by get ticket in detail

Fixed

• seen_by_admin switches to True when open ticket object in admin panel