Documentation

Explanation

Understanding-oriented discussion: the reasoning behind velodex's architecture, its index model, and the packaging standards it implements. You do not need this section to operate velodex; read it when you want to know why.

  • When to use velodex (and when not)

    The problems a read-through cache and private index solves, and the honest list of problems it does not.

  • Architecture

    How one process serves a pip install: the request path, the streaming cache, freshness, and the two stores.

  • Performance and methodology

    Measured numbers for cold and warm installs, the commands that produced them, and where the remaining time goes.

  • The index model

    Cached, hosted, and virtual indexes across ecosystems: how composition works, why shadowing is the dependency-confusion fix, and what removal means.

  • Standards

    The packaging PEPs and specifications velodex implements, and how they fit together.