# ardrake/django-helpdesk architecture

> Architecture diagram of the GitHub repository ardrake/django-helpdesk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ardrake/django-helpdesk
- Repository: https://github.com/ardrake/django-helpdesk

## Overview

django-helpdesk is a Django ticket tracker. Submitters create and check tickets through public views; staff manage tickets and follow-ups; integrations can create or update tickets through the API or inbound email. Ticket records and related configuration are represented by Django models. The tree also includes knowledge-base and feed views, plus scheduled escalation. Several of those modules were not excerpted, so their behavior is represented without speculative links; the graph focuses on relationships visible in excerpts or documented capabilities.

Main entry points: [`helpdesk/models.py`](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/models.py) (Ticket records), [`helpdesk/forms.py`](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/forms.py) (Ticket forms), [`helpdesk/views/public.py`](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/public.py) (Public views), [`helpdesk/views/staff.py`](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/staff.py) (Staff views)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User interfaces"]
  node_public_views["Public views<br/>[public.py]"]
  node_staff_views["Staff views<br/>[staff.py]"]
  node_api["Ticket API<br/>[api.py]"]
  node_knowledge_base["Knowledge base<br/>[kb.py]"]
  node_feeds["Ticket feeds<br/>[feeds.py]"]
  node_admin["Django admin<br/>[admin.py]"]
end

subgraph group_ticketing["Ticket workflows"]
  node_ticket_forms["Ticket forms<br/>[forms.py]"]
  node_common_lib["Mail and helpers<br/>[lib.py]"]
  node_spam_check["Spam checking<br/>[lib.py]"]
  node_akismet["Akismet integration<br/>[akismet.py]"]
end

subgraph group_operations["Email and operations"]
  node_email_ingest["Email ingestion<br/>[get_email.py]"]
  node_escalation["Ticket escalation"]
end

subgraph group_domain["Ticket domain"]
  node_ticket_models[("Ticket records<br/>[models.py]")]
  node_configuration["Helpdesk settings<br/>[settings.py]"]
end

node_submitter(("Submitter"))
node_staff_user(("Staff user"))
node_api_client(("API client"))
node_mail_sender(("Mail sender"))

node_submitter -.->|"submits or checks"| node_public_views
node_public_views -->|"validates submission"| node_ticket_forms
node_public_views -->|"checks spam"| node_spam_check
node_public_views -->|"queries tickets"| node_ticket_models
node_staff_user -.->|"manages tickets"| node_staff_views
node_staff_views -->|"uses forms"| node_ticket_forms
node_staff_views -->|"updates records"| node_ticket_models
node_staff_views -->|"renders context"| node_common_lib
node_api_client -.->|"calls API"| node_api
node_api -->|"creates tickets"| node_ticket_forms
node_api -->|"queries and updates"| node_ticket_models
node_mail_sender -.->|"sends mail"| node_email_ingest
node_email_ingest -->|"creates or updates"| node_ticket_models
node_email_ingest -->|"reads settings"| node_configuration
node_escalation -->|"escalates tickets"| node_ticket_models
node_escalation -->|"sends notifications"| node_common_lib
node_ticket_forms -->|"saves tickets"| node_ticket_models
node_ticket_forms -->|"sends mail"| node_common_lib
node_common_lib -->|"checks comments"| node_akismet
node_admin -->|"registers models"| node_ticket_models
node_admin -->|"reads settings"| node_configuration

click node_public_views "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/public.py"
click node_staff_views "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/staff.py"
click node_api "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/api.py"
click node_knowledge_base "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/kb.py"
click node_feeds "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/feeds.py"
click node_ticket_forms "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/forms.py"
click node_ticket_models "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/models.py"
click node_common_lib "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/lib.py"
click node_spam_check "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/lib.py"
click node_akismet "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/akismet.py"
click node_email_ingest "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/management/commands/get_email.py"
click node_escalation "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/management/commands/escalate_tickets.py"
click node_configuration "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/settings.py"
click node_admin "https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/admin.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_public_views,node_staff_views,node_api,node_knowledge_base,node_feeds,node_admin,node_staff_user,node_api_client toneBlue
class node_ticket_forms,node_common_lib,node_spam_check,node_akismet toneAmber
class node_email_ingest,node_escalation toneMint
class node_ticket_models,node_configuration toneRose
class node_submitter,node_mail_sender toneIndigo
```

## Components

### User interfaces

- [Public views](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/public.py): `helpdesk/views/public.py`
- [Staff views](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/staff.py): `helpdesk/views/staff.py`
- [Ticket API](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/api.py): `helpdesk/views/api.py`
- [Knowledge base](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/kb.py): `helpdesk/views/kb.py`
- [Ticket feeds](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/views/feeds.py): `helpdesk/views/feeds.py`
- [Django admin](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/admin.py): `helpdesk/admin.py`

### Ticket workflows

- [Ticket forms](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/forms.py): `helpdesk/forms.py`
- [Mail and helpers](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/lib.py): `helpdesk/lib.py`
- [Spam checking](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/lib.py): `helpdesk/lib.py`
- [Akismet integration](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/akismet.py): `helpdesk/akismet.py`

### Email and operations

- [Email ingestion](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/management/commands/get_email.py): `helpdesk/management/commands/get_email.py`
- [Ticket escalation](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/management/commands/escalate_tickets.py): `helpdesk/management/commands/escalate_tickets.py`

### Ticket domain

- [Ticket records](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/models.py): `helpdesk/models.py`
- [Helpdesk settings](https://github.com/ardrake/django-helpdesk/blob/master/helpdesk/settings.py): `helpdesk/settings.py`

### Other components

- **Submitter**
- **Staff user**
- **API client**
- **Mail sender**

## Connections

- Submitter → Public views: submits or checks (evidence: `helpdesk/views/public.py`)
- Public views → Ticket forms: validates submission (evidence: `helpdesk/views/public.py`)
- Public views → Spam checking: checks spam (evidence: `helpdesk/views/public.py`)
- Public views → Ticket records: queries tickets (evidence: `helpdesk/views/public.py`)
- Staff user → Staff views: manages tickets (evidence: `helpdesk/views/staff.py`)
- Staff views → Ticket forms: uses forms (evidence: `helpdesk/views/staff.py`)
- Staff views → Ticket records: updates records (evidence: `helpdesk/views/staff.py`)
- Staff views → Mail and helpers: renders context (evidence: `helpdesk/views/staff.py`)
- API client → Ticket API: calls API (evidence: `helpdesk/views/api.py`)
- Ticket API → Ticket forms: creates tickets (evidence: `helpdesk/views/api.py`)
- Ticket API → Ticket records: queries and updates (evidence: `helpdesk/views/api.py`)
- Mail sender → Email ingestion: sends mail (evidence: `helpdesk/management/commands/get_email.py`)
- Email ingestion → Ticket records: creates or updates (evidence: `helpdesk/management/commands/get_email.py`)
- Email ingestion → Helpdesk settings: reads settings (evidence: `helpdesk/management/commands/get_email.py`)
- Ticket escalation → Ticket records: escalates tickets (evidence: `helpdesk/management/commands/escalate_tickets.py`)
- Ticket escalation → Mail and helpers: sends notifications (evidence: `helpdesk/management/commands/escalate_tickets.py`)
- Ticket forms → Ticket records: saves tickets (evidence: `helpdesk/forms.py`)
- Ticket forms → Mail and helpers: sends mail (evidence: `helpdesk/forms.py`)
- Mail and helpers → Akismet integration: checks comments (evidence: `helpdesk/lib.py`)
- Django admin → Ticket records: registers models (evidence: `helpdesk/admin.py`)
- Django admin → Helpdesk settings: reads settings (evidence: `helpdesk/admin.py`)
