pjkm.cli.commands.groups

Group management commands — group create/import/validate/list/sync + source.

Attributes

group_app
source_app

Functions

group_create([group_id, name, output_dir])	Scaffold a new package group YAML definition.
group_import([pyproject, section, output_dir])	Import optional dependency groups from an external pyproject.toml.
group_validate([path])	Validate package group YAML definitions.
group_list()	List all available groups (built-in + custom + remote sources).
source_add([url, name, path, ref, sync_now])	Add a remote git repo as a group source.
source_remove([name])	Remove a registered group source and its cached data.
source_list()	List all registered group sources.
group_sync([name])	Sync (clone or update) remote group sources.

Module Contents

pjkm.cli.commands.groups.group_app

pjkm.cli.commands.groups.source_app

pjkm.cli.commands.groups.group_create(group_id=typer.Argument(help='Group ID (e.g. quant, ml-data)'), name=typer.Option('', '--name', '-n', help='Human-readable name'), output_dir=typer.Option('', '--dir', '-d', help='Output directory (default: ./.pjkm/groups/)'))

Scaffold a new package group YAML definition.

Creates a ready-to-edit YAML file. Add dependencies, set archetypes, and optionally reference template fragments.

Custom groups in ~/.pjkm/groups/ or ./.pjkm/groups/ are loaded automatically alongside built-in groups.

Parameters:

• group_id (str)

• name (str)

• output_dir (str)

Return type:

None

pjkm.cli.commands.groups.group_import(pyproject=typer.Argument(help='Path to pyproject.toml to import from'), section=typer.Option([], '--section', '-s', help='Specific sections to import (default: all)'), output_dir=typer.Option('', '--dir', '-d', help='Output directory (default: ./.pjkm/groups/)'))

Import optional dependency groups from an external pyproject.toml.

Reads [project.optional-dependencies] and creates a .yaml group file for each section. Great for importing groups from existing projects.

Example: pjkm group import ../ooai/packages/wraquant/pyproject.toml

Parameters:

• pyproject (str)

• section (list[str])

• output_dir (str)

Return type:

None

pjkm.cli.commands.groups.group_validate(path=typer.Argument('', help='Path to a .yaml file or directory (default: ./.pjkm/groups/)'))

Validate package group YAML definitions.

Checks that group files parse correctly, have valid schema, and that dependency references are resolvable.

Parameters:

path (str)

Return type:

None

pjkm.cli.commands.groups.group_list()

List all available groups (built-in + custom + remote sources).

Return type:

None

pjkm.cli.commands.groups.source_add(url=typer.Argument(help='Git repo URL containing group YAML files'), name=typer.Option('', '--name', '-n', help='Short name for this source'), path=typer.Option('', '--path', '-p', help='Subdirectory within repo containing .yaml files'), ref=typer.Option('', '--ref', '-r', help='Branch, tag, or commit to track'), sync_now=typer.Option(True, '--sync/--no-sync', help='Clone the repo immediately'))

Add a remote git repo as a group source.

The repo should contain .yaml group definition files (same format as built-in groups). After adding, groups from this source are available everywhere — in pjkm init, pjkm group list, etc.

Examples

pjkm group source add https://github.com/org/pjkm-groups-quant.git

pjkm group source add git@github.com:org/ooai.git

–path packages/wraquant/groups –name quant

pjkm group source add https://github.com/team/shared-groups.git

–ref main –name team-groups

Parameters:

• url (str)

• name (str)

• path (str)

• ref (str)

• sync_now (bool)

Return type:

None

pjkm.cli.commands.groups.source_remove(name=typer.Argument(help='Source name to remove'))

Remove a registered group source and its cached data.

Parameters:

name (str)

Return type:

None

pjkm.cli.commands.groups.source_list()

List all registered group sources.

Return type:

None

pjkm.cli.commands.groups.group_sync(name=typer.Argument('', help='Source name to sync (default: all)'))

Sync (clone or update) remote group sources.

Pulls the latest group definitions from registered git repos. Run this after adding a source or to get updates.

Parameters:

name (str)

Return type:

None