Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

Retriever

class cstar.io.retriever.Retriever(source: SourceData)

Bases: ABC, LoggingMixin

Class to handle retrieval of data for access by C-Star

read:

Reads data into memory, if supported

save:

Saves data to a target local path, if supported

Methods

Retriever.read()	Retrieve data to memory, if supported
Retriever.refresh(target_dir)	Refresh local data from the datasource.
Retriever.save(target_dir)	Save this object to the given directory.

Attributes

Retriever.log

Return the logger instance for this class.