genericissuetracker

A reusable, versioned, schema-safe Django Issue Tracker application.

Maintained by: https://djangoplay.org

genericissuetracker is a production-grade, installable Django app that drops issue tracking -- issues, comments, labels, and attachments -- into any Django project behind a versioned REST API.

Features

• Issue management with human-friendly, sequential issue numbers
• Comments and labels
• Attachments, including atomic multipart creation alongside an issue or comment
• Deterministic lifecycle state machine with a full status-history audit trail
• Soft delete throughout
• No dependency on AUTH_USER_MODEL -- reporter/uploader identity stored by email/user id
• Versioned REST API (/api/v1/...)
• Configurable permissions, pagination, and filtering
• OpenAPI schema support via drf-spectacular

Requirements

• Python 3.8 or later
• Django 4.2 or later
• djangorestframework 3.14 or later
• drf-spectacular 0.27 or later

Installation

pip install genericissuetracker

Add it to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "genericissuetracker",
]

Include its URLs:

path("api/", include("genericissuetracker.urls.root")),

Then run migrations:

python manage.py migrate

Configuration

All settings are namespaced under GENERIC_ISSUETRACKER_<SETTING>:

Example:

GENERIC_ISSUETRACKER_DEFAULT_PERMISSION_CLASSES = [
    "rest_framework.permissions.IsAuthenticated"
]

API Endpoints

Filtering and ordering are supported out of the box:

/api/v1/issues/?search=bug
/api/v1/issues/?ordering=-created_at

An OpenAPI schema and interactive docs are available at /schema/ and /docs/ (drf-spectacular).

Identity Model

Reporters and uploaders are tracked by reporter_email / uploaded_by_email plus an optional reporter_user_id / uploaded_by_user_id -- there is no hard foreign key to a user model, so the package drops into any Django auth setup unmodified.

Issue Identifiers

• id -- UUID, internal
• issue_number -- sequential, human-friendly, public

/api/v1/issues/12/

Links

• Homepage: https://gitlab.com/binaryfleet/issuetracker
• Repository: https://gitlab.com/binaryfleet/issuetracker
• Issues: https://gitlab.com/binaryfleet/issuetracker/issues
• Documentation: https://docs.djangoplay.org/view#projects/issuetracker/

License

genericissuetracker is released under the MIT License.