# oca/project-agile architecture

> Architecture diagram of the GitHub repository oca/project-agile, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oca/project-agile
- Repository: https://github.com/oca/project-agile

## Overview

##### Project type and purpose
- This is an Odoo “project_scrum” add-on module (version 10.0) that extends the core Project app with Scrum features (sprints, user stories, tests, meetings, etc.).
- It is not a standalone app but a plug-in that lives inside an Odoo server, enhancing its project management capabilities.

##### File structure
- Top-level:
- project_scrum/ – your module’s code
– models/ (Python ORM classes: project, sprint, meeting, US, test, task, actors)
– views/ (XML menu, form & tree views, mail templates)
– data/ (initial sequences, demo data, test task view)
– security/ (access rules, groups)
– i18n/ (translations)
– static/ (descriptions, assets)
– tests/ (unit tests)
– __manifest__.py (module metadata)
- setup/ – tooling for packaging/installing under Odoo’s “addons” path
- Config files: .travis.yml, .gitignore, oca_dependencies.txt, CI badges in README.

##### README
- Confirms it’s an OCA (Odoo Community Association) agile project management module.

a. Frontend (Odoo Web Client in the browser)
b. Odoo HTTP Server
c. Your module “project_scrum” (models, views, data, security, i18n, static)
d. Core Odoo modules (project, mail, base)
e. PostgreSQL database
f. External services (e.g., SMTP/Mail server for notifications)

##### Relationships & data flows
- Browser ↔ HTTP(s) ↔ Odoo Web Controller ↔ ORM Layer ↔ PostgreSQL
- ORM ↔ Python model classes in project_scrum & core modules
- XML view definitions ↔ Controller generate HTML/JSON for browser
- Mail templates in project_scrum/views ↔ Odoo mail subsystem ↔ SMTP server

##### Architectural patterns & principles
- MVC (Model = your Python files; View = XML definitions; Controller = Odoo HTTP + JS)
- Module-based extension: project_scrum hooks into existing project menus, models, workflows
- Data-driven (initial CSV/XML for security & sequences, demo data)

##### Technologies & frameworks
- Python 3 + Odoo 10 ORM
- XML for view definitions, data loading
- PostgreSQL as persistent store
- QWeb/JS for client interactions

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Layers
    subgraph "Client / Web Layer"
        Browser["Browser (HTML/JS)"]:::frontend
    end

    subgraph "Odoo Server Layer"
        OdooHTTP["Odoo HTTP Server"]:::server

        subgraph "project_scrum Module" 
            Manifest["__manifest__.py"]:::module
            subgraph "Models"
                PProject["project_project.py"]:::module
                PTask["project_task.py"]:::module
                Sprint["project_scrum_sprint.py"]:::module
                US["project_scrum_us.py"]:::module
                TestModel["project_scrum_test.py"]:::module
                Meeting["project_scrum_meeting.py"]:::module
                Actors["project_scrum_actors.py"]:::module
            end
            subgraph "Views"
                MenuXML["menu.xml"]:::module
                ViewProj["project_project.xml"]:::module
                ViewTask["project_task.xml"]:::module
                ViewSprint["project_scrum_sprint.xml"]:::module
                ViewUS["project_scrum_us.xml"]:::module
                ViewTest["project_scrum_test.xml"]:::module
                ViewMeeting["project_scrum_meeting.xml"]:::module
                MailTpl["mail_template.xml"]:::module
            end
            subgraph "Data & Demo"
                Seq["sequences_projects.xml"]:::module
                TestView["project_scrum_test_task_view.xml"]:::module
                Demo["project_scrum_demo.xml"]:::module
            end
            subgraph "Security"
                Groups["res_groups.xml"]:::module
                SecRules["project_security.xml"]:::module
                AccessCSV["ir.model.access.csv"]:::module
            end
            subgraph "i18n"
                POT["project_scrum.pot"]:::module
                POfiles["ar.po, de.po, en_US.po, fi.po, fr.po, sv_SE.po"]:::module
            end
            subgraph "Static Assets"
                Desc["description/"]:::module
            end
            subgraph "Tests"
                UTs["test_project_scrum.py"]:::module
            end
        end

        subgraph "Core Odoo Modules"
            CoreProj["project"]:::core
            CoreMail["mail"]:::core
            CoreBase["base"]:::core
        end

        subgraph "Setup Packaging"
            SetupMeta["_metapackage/setup.py"]:::module
            SetupAddon["project_scrum/odoo/addons/project_scrum"]:::module
            SetupInit["setup.py"]:::module
        end
    end

    subgraph "External Systems"
        DB["PostgreSQL DB"]:::external
        SMTP["SMTP Mail Server"]:::external
    end

    %% Flows
    Browser -->|"HTTP/JSON"| OdooHTTP
    OdooHTTP -->|"Controller→ORM"| PProject
    OdooHTTP --> CoreProj
    PProject -->|ORM CRUD| DB
    CoreProj -->|ORM CRUD| DB
    Sprint -->|extends| CoreProj
    PTask -->|extends| CoreProj
    US -->|extends| CoreProj
    TestModel -->|uses| CoreProj
    Actors -->|uses| CoreBase
    MailTpl -->|via mail subsystem| SMTP
    Seq -->|data load| DB
    Demo -->|demo load| DB
    AccessCSV -->|access rules| DB
    Groups -->|access rules| DB

    %% Setup flow
    SetupMeta -->|places module| SetupAddon
    SetupAddon -->|add to| OdooHTTP

    %% Click Events
    click Manifest "https://github.com/oca/project-agile/blob/10.0/project_scrum/__manifest__.py"
    click PProject "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_project.py"
    click PTask "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_task.py"
    click Sprint "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_scrum_sprint.py"
    click US "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_scrum_us.py"
    click TestModel "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_scrum_test.py"
    click Meeting "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_scrum_meeting.py"
    click Actors "https://github.com/oca/project-agile/blob/10.0/project_scrum/models/project_scrum_actors.py"
    click MenuXML "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/menu.xml"
    click ViewProj "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_project.xml"
    click ViewTask "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_task.xml"
    click ViewSprint "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_scrum_sprint.xml"
    click ViewUS "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_scrum_us.xml"
    click ViewTest "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_scrum_test.xml"
    click ViewMeeting "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/project_scrum_meeting.xml"
    click MailTpl "https://github.com/oca/project-agile/blob/10.0/project_scrum/views/mail_template.xml"
    click Seq "https://github.com/oca/project-agile/blob/10.0/project_scrum/data/sequences_projects.xml"
    click TestView "https://github.com/oca/project-agile/blob/10.0/project_scrum/data/project_scrum_test_task_view.xml"
    click Demo "https://github.com/oca/project-agile/blob/10.0/project_scrum/demo/project_scrum_demo.xml"
    click Groups "https://github.com/oca/project-agile/blob/10.0/project_scrum/security/res_groups.xml"
    click SecRules "https://github.com/oca/project-agile/blob/10.0/project_scrum/security/project_security.xml"
    click AccessCSV "https://github.com/oca/project-agile/blob/10.0/project_scrum/security/ir.model.access.csv"
    click POT "https://github.com/oca/project-agile/blob/10.0/project_scrum/i18n/project_scrum.pot"
    click UTs "https://github.com/oca/project-agile/blob/10.0/project_scrum/tests/test_project_scrum.py"
    click SetupMeta "https://github.com/oca/project-agile/blob/10.0/setup/_metapackage/setup.py"
    click SetupAddon "https://github.com/oca/project-agile/tree/10.0/setup/project_scrum/odoo/addons/project_scrum"
    click SetupInit "https://github.com/oca/project-agile/blob/10.0/setup/project_scrum/setup.py"

    %% Styles
    classDef frontend fill:#D6EAF8,stroke:#3498DB
    classDef server fill:#EBF5FB,stroke:#2E86C1
    classDef module fill:#D5F5E3,stroke:#27AE60
    classDef core fill:#EAFAF1,stroke:#28B463
    classDef external fill:#F2F3F4,stroke:#ABB2B9
```
