Modules¶

task¶

class refit.task.Concurrent(host_class)[source]¶

Bundles several tasks to be run concurrently.

async run()[source]¶: Override in subclasses. This is what does the actual work in the task, and is awaited when the Task is run.

class refit.task.Task(host_class)[source]¶

classmethod create(host_registry, environment)[source]¶

Creates and runs a task for all matching hosts.

async entrypoint()[source]¶

Kicks off the task, along with printing some info.

async raw(command, raise_exception=True)[source]¶: Execute a raw shell command on the remote server.

abstract async run()[source]¶

Override in subclasses. This is what does the actual work in the task, and is awaited when the Task is run.

refit.task.new_gathered_task(tasks)[source]¶

Task definitions are classes, not instances, hence why we require this.

Parameters: tasks (Iterable[Type[Task]]) – A list of Task classes to execute.
Return type: Type[Concurrent]

class refit.registry.HostRegistry[source]¶

get_host_classes(environment, tags)[source]¶

Returns hosts matching the given tags.

If no tags are given, all hosts match.

register(*host_classes, environment='production', tags=[])[source]¶

Register hosts as possible deployment targets.

async run_tasks(tasks, environment)[source]¶

Create and execute a Task for each matching host.

class refit.registry.TaskRegistry[source]¶

gather(*task_classes, tags=['all'])[source]¶

Register tasks, which will execute concurrently.

register(*task_classes, tags=['all'])[source]¶

Register tasks for execution - used either directly, or as a decorator.