API Documentation

Main module.

deskmaid.entrypoint(argv=None)[source]

Entrypoint for command line interface.

Parameters:

argv (Sequence[str] | None) –

Return type:

None

class deskmaid.Deskmaid(config)[source]

Bases: object

Parameters:

config (Config) –

__init__(config)[source]

Instanciate deskmaid.

Parameters:

config (Config) –

Return type:

None

static load(path=None, dry_run=None)[source]

Load config from path or default location.

Parameters:

  • path (Path | None) –

  • dry_run (bool | None) –

Return type:

Deskmaid

organize(*, path=None, recursive=None, dry_run=None)[source]

Organize all non-ignored files and return the moved files.

Parameters:

  • path (str | PurePath | None) –

  • recursive (bool | None) –

  • dry_run (bool | None) –

Return type:

Dict[Path, Path]

rename(path)[source]

Fix filenames.

Parameters:

path (Path) –

Return type:

Path

clean(*, path=None, recursive=None, dry_run=None)[source]

Run deskmaid.

Parameters:

  • path (str | PurePath | None) –

  • recursive (bool | None) –

  • dry_run (bool | None) –

Return type:

None

undo(dry_run=None)[source]

Undo last arrange.

Parameters:

dry_run (bool | None) –

Return type:

None

notify(message)[source]

Send desktop notification.

Parameters:

message (str) –

Return type:

bool

shortcut(debug=None)[source]

Create shortcut on desktop.

Parameters:

debug (bool | None) –

Return type:

None