cleek 0.3.0

A simple task runner that generates command line interfaces

A simple task runner that generates command line interfaces

from cleek import task

@task
def binary_op(x: int, y: int, op: Literal['add', 'sub'] = 'add') -> None:
    ...

⬇️ Becomes ⬇️

$ clk binary-op -h
usage: clk binary-op [-h] [-o {add,sub}] x y

positional arguments:
  x
  y

options:
  -h, --help          show this help message and exit
  -o, --op {add,sub}  default: add

See how I cleek in another project

Install

PyPI

$ pip install cleek

GitHub

$ git clone https://github.com/petersuttondev/cleek.git
$ pip install ./cleek

Get Started

1. Create a cleeks.py file in the root of your project and add tasks.

from cleek import task

@task
def greet(name: str) -> None:
    print(f'Hello, {name}!')

2. Run clk from anywhere inside your project to see your tasks.

$ clk
┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓
┃ Task  ┃ Usage               ┃
┡━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩
│ greet │ clk greet [-h] name │
└───────┴─────────────────────┘

3. Run clk <task> -h to print a task's help.

$ clk greet
usage: clk greet [-h] name

positional arguments:
  name

options:
  -h, --help  show this help message and exit

4. Run a task.

$ clk greet Peter
Hello, Peter!

Customizing Tasks

Set a task's name:

from cleek import task

@task('bar')
def foo() -> None:
    print('foo function, bar task')

$ clk bar
foo function, bar task

Set a task's group:

from cleek import task

@task(group='foo')
def bar() -> None:
    print('bar task in the foo group')

$ clk foo.bar
bar task in the foo group

Set a task's style. Used when listing tasks. See Rich's Style documentation for supported styles.

from cleek import task

@task(style='red')
def foo() -> None:
    print("I'll be red if you run clk")

To apply the same customization to many tasks, use customize() to create a pre-configured version of the task decorator.

from cleek import customize

foo_task = customize('foo', style='red')

@foo_task
def a() -> None: ...

@foo_task
def b() -> None: ...

bar_task = customize('bar', style='blue')

@bar_task
def c() -> None: ...

@bar_task
def d() -> None: ...

$ clk
┏━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Task  ┃ Usage          ┃
┡━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ foo.a │ clk foo.a [-h] │
│ foo.b │ clk foo.b [-h] │
│ bar.c │ clk bar.c [-h] │
│ bar.d │ clk bar.d [-h] │
└───────┴────────────────┘

Shell Completion

Shell completion is provided by argcomplete:

1. Setup argcomplete following their installation instructions

2. Add eval "$(register-python-argcomplete clk)" to your shell configuration.

Async Support

Your tasks can be async functions:

from cleek import task
import trio

@task
async def sleep(duration: float = 1.0) -> None:
    print(f'Sleeping for {duration} seconds')
    await trio.sleep(duration)

At the moment, trio is the only supported event loop. If want to use another event loop (I'm guessing asyncio), open an issue and I'll add it.

Finding Tasks

1. If the environmental variable CLEEKS_PATH is set, clk treats the value as a path and attempts to load it. If the load fails, clk fails.

2. clk searches upwards from the current working directory towards the root directory /, looking for a cleeks.py script or a cleeks package. A script takes precedence over a package if both are found in the same directory.

Supported Parameters

If you get an error saying your task's parameters are not supported, open an issue containing the function signature and I'll add support.

bool

Keyword bool with False or True default

def foo(a: bool = False): ...
def foo(a: bool = True): ...

Keyword optional bool with False, True, or None default

def foo(a: bool | None = False): ...
def foo(a: bool | None = True): ...
def foo(a: bool | None = None): ...

str

Positional str

def foo(a: str): ...

Positional optional str

def foo(a: str | None): ...

Keyword str with str default

def foo(a: str = 'a'): ...

Keyword optional str with str or None default

def foo(a: str | None = 'a'): ...
def foo(a: str | None = None): ...

Variadic positional str

def foo(*a: str): ...

int

Positional int

def foo(a: int): ...

Keyword int with int default

def foo(a: int = 1): ...

Keyword optional int with int or None default

def foo(a: int | None = 1): ...
def foo(a: int | None = None): ...

float

Positional float

def foo(a: float): ...

Keyword float with float default

def foo(a: float = 1.0): ...

Keyword optional float with float or None default

def foo(a: float | None = 1.0): ...
def foo(a: float | None = None): ...

Literal[T]

Positional int literal

@task
def foo(a: Literal[1, 2, 3]): ...

Positional str literal

@task
def foo(a: Literal['a', 'b', 'c']): ...

Keyword int literal with int default

@task
def foo(a: Literal[1, 2, 3] = 1): ...

Keyword str literal with str default

@task
def foo(a: Literal['a', 'b', 'c'] = 'a'): ...

Misc

Variadic positional pathlib.Path

from pathlib import Path

@task
def foo(*a: Path): ...

Variadic positional trio.Path

from trio import Path

@task
def foo(*a: Path): ...