collective.transmute.commands

`collective.transmute.commands`#

The collective.transmute.commands module provides the following interfaces.

collective.transmute.commands.info.info() → None[source]#: Show information about the collective.transmute tool and its main dependencies.

collective.transmute.commands.report._create_state(app_layout: ApplicationLayout, files: Iterator) → ReportState[source]#: Initialize a ReportState object.

async collective.transmute.commands.report._write_type_report(dst: Path, type_: str, state: ReportState) → Path[source]#: Write a CSV report for a specific content type.

collective.transmute.commands.report.report(ctx: ~typer.models.Context, src: ~typing.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x107956a50>], dst: ~typing.Annotated[~pathlib.Path | None, <typer.models.ArgumentInfo object at 0x107686fd0>] = None, report_types_: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x107946e90>] = '')[source]#: Generates a JSON file with a report of export data in src directory.

collective.transmute.commands.sanity.sanity(ctx: Context) → None[source]#: Run a sanity check on pipeline steps.

collective.transmute.commands.settings.dump_settings(settings: TransmuteSettings) → str[source]#: Dump settings as TOML string.

collective.transmute.commands.settings.generate() → None[source]#: Generate a new transmute.toml settings file in the current directory.

collective.transmute.commands.settings.settings(ctx: Context) → None[source]#: Report settings to be used by this application.

collective.transmute.commands.transmute._create_state(app_layout: ApplicationLayout, total: int, metadata: MetadataInfo | None = None, write_report: bool = True) → PipelineState[source]#: Initialize a PipelineState object.

collective.transmute.commands.transmute.run(ctx: ~typer.models.Context, src: ~typing.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x107947890>], dst: ~typing.Annotated[~pathlib.Path, <typer.models.ArgumentInfo object at 0x107947c50>], write_report: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x107947d90>] = False, clean_up: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x107947250>] = False, ui: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x107947610>] = True)[source]#: Transmutes data from src folder (in collective.exportimport format) to plone.exportimport format in the dst folder.