API

quickie

A CLI tool for quick tasks.

quickie.task

Create a task from a function.

quickie.script

Create a script from a function.

quickie.command

Create a command task from a function.

quickie.arg

Used to add arguments to the arguments parser of a task.

quickie.generic_task_factory

Create a task class from a function.

quickie.group

Create a group task from a function.

quickie.thread_group

Create a thread group task from a function.

quickie.lazy_task

Loads a task lazily by name.

quickie.partial_task

Wraps a task class with partial arguments.

quickie.suppressed_task

Wraps a task class to silently suppress errors.

quickie.tasks.Task

Base class for all tasks.

quickie.tasks.Script

Base class for tasks that run a script.

quickie.tasks.Command

Base class for tasks that run a binary.

quickie.tasks.Group

Base class for tasks that run other tasks in sequence.

quickie.tasks.ThreadGroup

Base class for tasks that run other tasks in threads.

quickie.completion

Completers for task arguments.

quickie.completion.BaseCompleter

Base class for completers.

quickie.completion.PathCompleter

For auto-completing file paths.

quickie.completion.python

Python completers for quickie.

quickie.completion.python.PytestCompleter

For auto-completion of paths, but also adds python module completion.

quickie.conditions

Useful check tasks.

quickie.conditions.condition

Decorator to create a condition from a function.

quickie.conditions.FilesModified

Check if files have been not being modified.

quickie.conditions.FirstRun

Check if the task is running for the first time.

quickie.conditions.PathsExist

Check if the given paths exist.

quickie.conditions.base

Contains the base classes for task conditions.

quickie.conditions.base.BaseCondition

Base class for all conditions.

quickie.config

Settings for quickie.

quickie.config.CliConfig

Settings for quickie.

quickie.context

Task context.

quickie.context.Context

The context for a task.

quickie.errors

Errors for quickie.

quickie.errors.QuickieError

Base class for quickie errors.

quickie.errors.Stop

Raised when execution should stop.

quickie.errors.TaskNotFoundError

Raised when a task is not found.

quickie.errors.TasksModuleNotFoundError

Raised when a module is not found.

quickie.factories

Factories for creating tasks from functions.

quickie.factories.arg

Used to add arguments to the arguments parser of a task.

quickie.factories.command

Create a command task from a function.

quickie.factories.generic_task_factory

Create a task class from a function.

quickie.factories.group

Create a group task from a function.

quickie.factories.script

Create a script from a function.

quickie.factories.task

Create a task from a function.

quickie.factories.thread_group

Create a thread group task from a function.