Skip to content

Reference

Technical reference documentation for Stardag.

API Reference

Auto-generated documentation from source code:

Core Classes

Class Description
BaseTask Minimal core API for all tasks
LoadableTask Abstract base with load() -> T
TargetTask Base class for tasks with typed targets
Task Default: auto filesystem targets (diamond)
@task Decorator for function-based tasks

Dependency Types

Type Description
Depends[T] Inject loaded output
TaskLoads[T] Access task object
TaskSet[T] Handle multiple tasks

Build Functions

Function Description
build() Execute task and dependencies

Target Types

Class Description
FileSystemTarget Base filesystem target (minimal: uri + exists())
FileTarget File-oriented target (open(), proxy_path(), etc.)
DirectoryTarget Directory-oriented target (sub-targets + done flag)
LoadableSaveableTarget Target with serialization

Configuration

Function Description
get_file_target() Create file target from relative path
get_directory_target() Create directory target from relative path
target_factory_provider Manage target factory

External Resources