pjkm.core.groups.sources

Remote group source management: clone, cache, and sync git repos of group definitions.

Attributes

CACHE_DIR
SOURCES_FILE

Classes

SourceEntry	A registered group source.
GroupSourceManager	Manages remote git repositories that provide group definitions.

Module Contents

pjkm.core.groups.sources.CACHE_DIR

pjkm.core.groups.sources.SOURCES_FILE

class pjkm.core.groups.sources.SourceEntry(url, name='', path='', ref='')

A registered group source.

Parameters:

• url (str)

• name (str)

• path (str)

• ref (str)

url

name

path = ''

ref = ''

property cache_dir: pathlib.Path

Return type:

pathlib.Path

property groups_dir: pathlib.Path

The directory containing group YAML files within the cached repo.

Return type:

pathlib.Path

to_dict()

Return type:

dict[str, str]

classmethod from_dict(data)

Parameters:

data (dict[str, Any])

Return type:

SourceEntry

class pjkm.core.groups.sources.GroupSourceManager

Manages remote git repositories that provide group definitions.

Sources are registered in ~/.pjkm/sources.yaml and cached in ~/.pjkm/cache/sources/<name>/. They can also be declared in .pjkmrc.yaml under group_sources:.

load()

Load registered sources from ~/.pjkm/sources.yaml.

Return type:

None

load_from_defaults(sources)

Load additional sources from UserDefaults.group_sources.

Parameters:

sources (list[dict[str, str]])

Return type:

None

save()

Persist the source list to ~/.pjkm/sources.yaml.

Return type:

None

property sources: list[SourceEntry]

Return type:

list[SourceEntry]

add(url, name='', path='', ref='')

Register a new group source.

Parameters:

• url (str)

• name (str)

• path (str)

• ref (str)

Return type:

SourceEntry

remove(name)

Remove a registered source by name. Returns True if found.

Parameters:

name (str)

Return type:

bool

sync(name=None)

Clone or pull registered sources.

Parameters:

name (str | None) – If given, only sync this source. Otherwise sync all.

Returns:

List of (source, success, message) tuples.

Return type:

list[tuple[SourceEntry, bool, str]]

get_all_group_dirs()

Return (source_name, groups_dir) for all cached sources that exist.

Return type:

list[tuple[str, pathlib.Path]]