pjkm.core.defaults

User defaults: loads config from ~/.pjkmrc.yaml or ./.pjkmrc.yaml.

Classes

GitHubDefaults	GitHub/remote repository defaults.
GroupSource	A remote git repo containing package group YAML definitions.
UserDefaults	User-configurable defaults loaded from .pjkmrc.yaml files.

Module Contents

class pjkm.core.defaults.GitHubDefaults(/, **data)

Bases: pydantic.BaseModel

GitHub/remote repository defaults.

Parameters:

data (Any)

org: str = ''

visibility: str = 'private'

remote: str = ''

create_repo: bool = False

default_branch: str = 'main'

class pjkm.core.defaults.GroupSource(/, **data)

Bases: pydantic.BaseModel

A remote git repo containing package group YAML definitions.

Parameters:

data (Any)

url: str

name: str = ''

path: str = ''

ref: str = ''

class pjkm.core.defaults.UserDefaults(/, **data)

Bases: pydantic.BaseModel

User-configurable defaults loaded from .pjkmrc.yaml files.

Parameters:

data (Any)

author_name: str = ''

author_email: str = ''

license: str = 'MIT'

python_version: str = '3.13'

archetype: str = 'single_package'

groups: list[str] = None

target_dir: str = '.'

github: GitHubDefaults = None

group_sources: list[GroupSource] = None

classmethod load()

Load defaults from config files.

Searches in order (later files override earlier): 1. ~/.pjkmrc.yaml (global defaults) 2. ./.pjkmrc.yaml (project/workspace defaults)

Return type:

UserDefaults