Status#

Description#

Given the URL for a top level wrapp file, return an ordered list of packages that are dirty, and a map of wrapp file to the list of detailed status entries found in that subpackage.

To help detect issues of a modified folder content, the status command can be used to compare the content of an installed folder with the originally installed content. This checks if an installed package with all its subpackages is unmodified.

For usage examples, see the Tutorial. For CLI options, run wrapp status --help.

Python API Reference#

async wrapp.status(
wrapp_file: str,
ignore_file: str | None = None,
*,
context: CommandParameters = CommandParameters(debug=False, verbose=False, dry_run=False, log_file=None, hash_cache_file=None),
scheduler: SchedulerContext | None = None,
) → Tuple[List[str], Dict[str, List[PackageStatusItem]]]#

Given the URL for a top level wrapp file, return an ordered list of packages that are dirty, and a map of wrapp file to the list of detailed PackageStatusItem entries found in that subpackage.

Parameters:

  • wrapp_file – Full URL for the top level wrapp file

  • ignore_file – Specify the name of an ignore file containing rules for ignoring items