servicex.app package

Submodules

servicex.app.cache module

servicex.app.cache.cache()[source]

Sub-commands for creating and manipulating the local query cache

servicex.app.cache.clear(force: bool = <typer.models.OptionInfo object>)[source]

Clear the local query cache

servicex.app.cache.delete(transform_id: str = <typer.models.ArgumentInfo object>)[source]

Delete a cached query. Use -t to specify the transform ID

servicex.app.cache.list()[source]

List the cached queries

servicex.app.cli_options module

servicex.app.codegen module

servicex.app.codegen.flush(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>)[source]

Flush the available code generators from the cache

servicex.app.codegen.list(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>)[source]

List the available code generators

servicex.app.main module

servicex.app.main.deliver(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, spec_file: str = <typer.models.ArgumentInfo object>, ignore_cache: bool | None = <typer.models.OptionInfo object>)[source]

Deliver a file to the ServiceX cache.

servicex.app.main.main_info(version: bool | None = <typer.models.OptionInfo object>)[source]

ServiceX Client

servicex.app.main.show_version(show: bool)[source]

Display the installed version and quit.

servicex.app.transforms module

class servicex.app.transforms.LogLevel(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Level of the log messages: INFO & ERROR

error = 'ERROR'
info = 'INFO'
class servicex.app.transforms.TimeFrame(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Time Frame levels: ‘day’, ‘week’ & ‘month’

day = 'day'
month = 'month'
week = 'week'
servicex.app.transforms.add_query(key, value)[source]

Creates query string from the key and value pairs

servicex.app.transforms.cancel(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id_list: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]

Cancel a running transform request.

Create the _a and _g parameters for the kibana dashboard link

servicex.app.transforms.delete(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id_list: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]

Delete a completed transform along with the result files.

servicex.app.transforms.download(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo object>, local_dir: str = <typer.models.OptionInfo object>, concurrency: int = <typer.models.OptionInfo object>)[source]

Download the files that were produced by a transform.

servicex.app.transforms.files(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo object>)[source]

List the files that were produced by a transform.

servicex.app.transforms.list(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, complete: bool | None = <typer.models.OptionInfo object>, running: bool | None = <typer.models.OptionInfo object>)[source]

List the transforms that have been run.

servicex.app.transforms.logs(backend: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo object>, log_level: ~servicex.app.transforms.LogLevel | None = <typer.models.OptionInfo object>, time_frame: ~servicex.app.transforms.TimeFrame | None = <typer.models.OptionInfo object>)[source]

Open the URL to the Kibana dashboard of the logs of a tranformer

servicex.app.transforms.select_time(time_frame=TimeFrame.day)[source]

Takes input as ‘day’,’week’,’month’ and returns the time filter

servicex.app.transforms.transforms()[source]

Sub-commands for interacting with transforms.

Module contents

servicex.app.is_terminal_output()[source]
servicex.app.pipeable_table(title: str)[source]

Create a table that can be used in a pipeable command. Make it pretty if we are outputting to a terminal, otherwise just make it as simple as possible.