Package dependencies¶

canVODpy is split into packages, and each package is in one layer. A package depends only on packages of its own layer or of a lower one. This page shows the dependencies between the packages, how many packages each one depends on, and what each package needs when you install it on its own. For what each layer does, see Architecture.

The page lists the dependencies that each pyproject.toml declares under [project] dependencies. Optional packages, such as canvod-filemap from canvodpy-extensions, aren't part of it.

Dependency graph¶

An arrow points from a package to a package it depends on. To keep the graph readable, it leaves out canvodpy, which depends on all eleven other packages, and every dependency that another path already implies: for example, canvod-store also depends on canvod-utils, which it reaches through canvod-store-metadata and canvod-config. The tables below list every declared dependency.

graph TD
    subgraph PRESENTATION["Presentation"]
        VIZ["canvod-viz"]
    end
    subgraph PERSISTENCE["Persistence"]
        STORE_METADATA["canvod-store-metadata"]
        STORE["canvod-store"]
    end
    subgraph COMPUTATION["Computation"]
        VOD["canvod-vod"]
        GRIDS["canvod-grids"]
        OPS["canvod-ops"]
    end
    subgraph DATA_INPUT["Data input"]
        READERS["canvod-readers"]
        AUXILIARY["canvod-auxiliary"]
        PREFLIGHT["canvod-preflight"]
    end
    subgraph FOUNDATION["Foundation"]
        UTILS["canvod-utils"]
        CONFIG["canvod-config"]
    end

    VIZ --> GRIDS
    STORE_METADATA --> CONFIG
    STORE --> AUXILIARY & GRIDS & STORE_METADATA & VOD
    VOD --> UTILS
    GRIDS --> UTILS
    OPS --> CONFIG & GRIDS
    READERS --> CONFIG
    AUXILIARY --> READERS
    PREFLIGHT --> UTILS
    CONFIG --> UTILS

Coupling¶

12 packages, 32 dependencies between them.

• Ce: the number of packages that this package depends on.
• Ca: the number of packages that depend on this package.
• Instability: Ce / (Ce + Ca). A package with 0 depends on no other package; a package with 1 has no package that depends on it.

canvod-utils and canvod-config have the most dependents (Ca = 9 and 6): a change there affects the most packages.

Install a package on its own¶

Each canvod-* package installs on its own, with the packages it needs. For example, uv add canvod-grids also installs canvod-utils:

Checks¶

• just check-package-imports installs each package with only its declared dependencies and imports every module, so a dependency that a package uses but doesn't declare fails in CI.
• just deps-report prints the tables on this page, and just deps-mermaid prints the graph. Both read the pyproject.toml files and fail if a package depends on a package of a higher layer, or if a package has no layer in scripts/analyze_dependencies.py.