# arrobalytics/django-ledger architecture

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

- Interactive diagram: https://gitdiagram.com/arrobalytics/django-ledger
- Repository: https://github.com/arrobalytics/django-ledger

## Overview

##### Project type and purpose
- Django Ledger is a full-stack Django application (a pluggable accounting engine) with both server-side components (models, forms, views, GraphQL API, management commands) and a client side UI (Webpack-built assets, templates, styles). It provides a high-level double-entry accounting API for Django projects and ships its own “dev_env” Django project for development/testing.

##### File structure
- Top-level directories:
- dev_env/ – a standalone Django project for local development (ASGI/WSGI, settings, urls)
- django_ledger/ – the accounting engine code:
– models/, forms/, views/, urls/, templates/, static/ – classic Django MVC layers
– io/ – file import core (OFX/QFX importer, middleware)
– contrib/django_ledger_graphene/ – GraphQL schema, mutations, API adapters
– management/commands – Django CLI extensions (e.g. generate_oauth2_codes)
- assets/ – front-end source (TypeScript, Less/SCSS), tsconfig, webpack.config.js, package.json
- docs/ & notebooks/ – user/developer documentation and examples
- Dockerfile & docker-compose.yml – containerization for development/CI
- README.md, Pipfile, setup.py, pyproject.toml – project metadata, dependencies, packaging

##### README for additional insights
- Confirms MVC pattern, GraphQL support, static-asset pipeline, Docker/dev environment, multi-tenant support, file import, financial reports.

##### Detailed checklist for the principal software engineer
- Dev_env Django project as a separate “development sandbox” connecting to the same core components
- To capture:
- HTTP server entry (ASGI/WSGI)
- URL routing (django_ledger/urls & dev_env/urls)
- Views & GraphQL resolvers
- Forms & validation
- Business modules (report, io, transaction engines)
- ORM & database
- Static file bundling & delivery
- External file import and management commands

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer" 
        direction TB
        Browser[(Browser)]:::frontend
        assets_src["assets/src"]:::frontend
        webpack_config["webpack.config.js"]:::frontend
        tsconfig["tsconfig.json"]:::frontend
        package_json["package.json"]:::frontend
        static_assets["bundle (static assets)"]:::frontend
        templates["templates (Django UI)"]:::frontend
    end

    %% Development Sandbox
    subgraph "Development Sandbox" 
        direction TB
        asgi["asgi.py"]:::api
        wsgi["wsgi.py"]:::api
        dev_urls["urls.py"]:::api
    end

    %% Application Layer
    subgraph "Application Layer"
        direction TB
        core_urls["core URLs"]:::api
        views["Django Views"]:::api
        api_adapter["GraphQL API adapter"]:::api
        graphql_schema["GraphQL schema"]:::api
        graphql_mutations["GraphQL mutations"]:::api
        forms["Django Forms"]:::biz
        io["Import Service (IO)"]:::biz
        report["Reporting Engine"]:::biz
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        direction TB
        models["ORM Models"]:::data
        migrations["Migrations"]:::data
        db[(Database)]:::data
    end

    %% External Integrations & Tooling
    subgraph "External & Tooling"
        direction TB
        ofx["OFX/QFX Importer"]:::external
        mgmt_cmd["generate_oauth2_codes.py"]:::biz
        dockerfile["Dockerfile"]:::infra
        docker_compose["docker-compose.yml"]:::infra
        entrypoint["entrypoint.sh"]:::infra
        ci_django[".github/workflows/Django.yml"]:::infra
        ci_pylint[".github/workflows/pylint.yml"]:::infra
        docs["docs/"]:::infra
        notebooks["notebooks/"]:::infra
    end

    %% Flows
    Browser -->|HTTP request| asgi
    Browser -->|HTTP request| wsgi
    asgi --> dev_urls
    wsgi --> dev_urls
    dev_urls --> core_urls
    core_urls --> views
    core_urls --> api_adapter
    api_adapter --> graphql_schema
    api_adapter --> graphql_mutations
    views --> forms
    forms --> io
    api_adapter --> report
    io --> models
    report --> models
    models --> db
    migrations --> db
    ofx --> io
    mgmt_cmd --> io
    mgmt_cmd --> report
    mgmt_cmd --> db
    dockerfile --> asgi
    docker_compose --> asgi
    docker_compose --> wsgi
    ci_django --> docker_compose
    ci_pylint --> docker_compose
    docs --> Browser
    notebooks --> Browser
    assets_src --> webpack_config
    webpack_config --> package_json
    package_json --> static_assets
    static_assets --> Browser
    templates --> Browser

    %% Click events
    click assets_src "https://github.com/arrobalytics/django-ledger/tree/master/assets/src/"
    click webpack_config "https://github.com/arrobalytics/django-ledger/blob/master/assets/webpack.config.js"
    click tsconfig "https://github.com/arrobalytics/django-ledger/blob/master/assets/tsconfig.json"
    click package_json "https://github.com/arrobalytics/django-ledger/blob/master/assets/package.json"
    click static_assets "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/static/django_ledger/bundle/"
    click templates "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/templates/django_ledger/"
    click asgi "https://github.com/arrobalytics/django-ledger/blob/master/dev_env/asgi.py"
    click wsgi "https://github.com/arrobalytics/django-ledger/blob/master/dev_env/wsgi.py"
    click dev_urls "https://github.com/arrobalytics/django-ledger/blob/master/dev_env/urls.py"
    click core_urls "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/urls/"
    click views "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/views/"
    click api_adapter "https://github.com/arrobalytics/django-ledger/blob/master/django_ledger/contrib/django_ledger_graphene/api.py"
    click graphql_schema "https://github.com/arrobalytics/django-ledger/blob/master/django_ledger/contrib/django_ledger_graphene/*/schema.py"
    click graphql_mutations "https://github.com/arrobalytics/django-ledger/blob/master/django_ledger/contrib/django_ledger_graphene/*/mutations.py"
    click forms "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/forms/"
    click io "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/io/"
    click report "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/report/"
    click models "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/models/"
    click migrations "https://github.com/arrobalytics/django-ledger/tree/master/django_ledger/migrations/"
    click ofx "https://github.com/arrobalytics/django-ledger/blob/master/django_ledger/io/ofx.py"
    click mgmt_cmd "https://github.com/arrobalytics/django-ledger/blob/master/django_ledger/management/commands/generate_oauth2_codes.py"
    click dockerfile "https://github.com/arrobalytics/django-ledger/tree/master/Dockerfile"
    click docker_compose "https://github.com/arrobalytics/django-ledger/blob/master/docker-compose.yml"
    click entrypoint "https://github.com/arrobalytics/django-ledger/blob/master/entrypoint.sh"
    click ci_django "https://github.com/arrobalytics/django-ledger/blob/master/.github/workflows/Django.yml"
    click ci_pylint "https://github.com/arrobalytics/django-ledger/blob/master/.github/workflows/pylint.yml"
    click docs "https://github.com/arrobalytics/django-ledger/tree/master/docs/"
    click notebooks "https://github.com/arrobalytics/django-ledger/tree/master/notebooks/"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#006064
    classDef api fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20
    classDef biz fill:#FFF3E0,stroke:#E65100,color:#E65100
    classDef data fill:#F3E5F5,stroke:#4A148C,color:#4A148C
    classDef external fill:#FFEBEE,stroke:#B71C1C,color:#B71C1C
    classDef infra fill:#ECEFF1,stroke:#37474F,color:#37474F
```
