venvstacks.stacks

Warning

The Python API is NOT YET STABLE. Function, class, and method names may change between releases without any deprecation period.

Portable Python environment stacks

Creates Python runtime, framework, and app environments based on venvstacks.toml

High Level Interface

StackSpec	Layered environment stack specification
BuildEnvironment	Interface to build specified layered environment stacks

Layer Metadata Components

LayerCategories	Enum for defined layer categories (collections of each variant)
LayerSpecMetadata	Details of a defined environment layer
LayerVariants	Enum for defined layer variants
TargetPlatform	alias of TargetPlatforms
TargetPlatforms	Enum for support target deployment platforms

Archive Publishing Results

ArchiveBuildMetadata	Inputs to an archive build request for a single environment
ArchiveBuildRequest	Structured request to build a named output archive
ArchiveHashes	Hash details of a built archive
ArchiveMetadata	Archive details for a single environment (includes build request details)
PublishedArchivePaths	Locations of published metadata and archive files
StackPublishingRequest	Inputs to an archive build request for a full stack specification
StackPublishingResult	Archive details for built stack specification (includes build request details)

Layer Export Results

EnvironmentExportRequest	Structured request to locally export an environment
ExportMetadata	Metadata for a locally exported environment
ExportedEnvironmentPaths	Locations of exported metadata files and deployed environments
StackExportRequest	Inputs to an environment export request for a full stack specification

Layer Specifications

RuntimeSpec	Base runtime layer specification
FrameworkSpec	Framework layer specification
ApplicationSpec	Application layer specification

Layer Build Environments

ApplicationEnv	Application layer build environment
FrameworkEnv	Framework layer build environment
RuntimeEnv	Base runtime layer build environment
EnvironmentLock	Layered environment dependency locking management
EnvironmentLockMetadata	Details of the last time this environment was locked

Build Process Configuration

PackageIndexConfig

Python package index access configuration

Exceptions

BuildEnvError	Raised when a build environment doesn't comply with process restrictions
EnvStackError	Common base class for all errors specific to managing environment stacks
LayerSpecError	Raised when an internal inconsistency is found in a layer specification