cuery.cli#

Attributes#

app

PROJ_DIR

Functions#

list_tasks()

List all registered Task instances (pretty print).

run_task(task_name, csv, output)

Execute a Task instance by id with a CSV file as input.

launch_builder()

Launch the interactive schema builder interface.

generate_seo_schema([output])

Generate the SEO schema JSON file.

set_env_([apify_secrets])

Set environment variables from configuration files.

actor(name[, apify_secrets])

_make_scaffold([tool, actor_name, module_name, title, ...])

Create a new actor directory and module for a given FlexTool subclass.

Module Contents#

cuery.cli.app#
cuery.cli.PROJ_DIR#
cuery.cli.list_tasks()#

List all registered Task instances (pretty print).

cuery.cli.run_task(task_name, csv, output)#

Execute a Task instance by id with a CSV file as input.

Parameters:

  • task_name (str)

  • csv (pathlib.Path)

  • output (pathlib.Path)

cuery.cli.launch_builder()#

Launch the interactive schema builder interface.

cuery.cli.generate_seo_schema(output=Path('input_schema.json'))#

Generate the SEO schema JSON file.

Parameters:

output (pathlib.Path)

cuery.cli.set_env_(apify_secrets=True)#

Set environment variables from configuration files.

Parameters:

apify_secrets (bool)

cuery.cli.actor(name, apify_secrets=True)#
Parameters:

  • name (str)

  • apify_secrets (bool)

cuery.cli._make_scaffold(tool=typer.Argument(..., help='Import path to FlexTool subclass, e.g. cuery.tools.flex.classify.Classifier'), actor_name=typer.Option(None, help='Directory name for the new actor (default from tool class)'), module_name=typer.Option(None, help='Module name to create in src/cuery/actors (default from tool class)'), title=typer.Option(None, help='Actor title (default from tool class name)'), description=typer.Option(None, help='Actor description (default from tool class docstring)'), force=typer.Option(False, '--force', help='Overwrite existing files'))#

Create a new actor directory and module for a given FlexTool subclass.

Parameters:

  • tool (str)

  • actor_name (str | None)

  • module_name (str | None)

  • title (str | None)

  • description (str | None)

  • force (bool)

Return type:

None