Index

`core`

AXM Core package.

`build_member_data(member_name, workspace_name, scaffold_data, *, license_holder=None, private=None)`

Build copier template variables for a workspace member scaffold.

Parameters:

Name	Type	Description	Default
`member_name`	`str`	Name of the new member package.	required
`workspace_name`	`str`	Parent workspace name (used for URLs).	required
`scaffold_data`	`Mapping[str, str]`	Caller identity fields — `org`, `author_name`, `author_email`, `license` and optionally `description`.	required
`license_holder`	`str \| None`	Explicit LICENSE holder; falls back to `org`.	`None`
`private`	`bool \| None`	Publication guard forwarded to Copier when provided.	`None`

Returns:

Type	Description
`dict[str, object]`	The template-variable dict passed verbatim to copier. Identical inputs
`dict[str, object]`	yield a byte-identical dict whatever the calling interface.

Source code in packages/axm-init/src/axm_init/core/scaffolder.py

Python
def build_member_data(
    member_name: str,
    workspace_name: str,
    scaffold_data: Mapping[str, str],
    *,
    license_holder: str | None = None,
    private: bool | None = None,
) -> dict[str, object]:
    """Build copier template variables for a workspace member scaffold.

    Args:
        member_name: Name of the new member package.
        workspace_name: Parent workspace name (used for URLs).
        scaffold_data: Caller identity fields — ``org``, ``author_name``,
            ``author_email``, ``license`` and optionally ``description``.
        license_holder: Explicit LICENSE holder; falls back to ``org``.
        private: Publication guard forwarded to Copier when provided.

    Returns:
        The template-variable dict passed verbatim to copier. Identical inputs
        yield a byte-identical dict whatever the calling interface.
    """
    org = scaffold_data["org"]
    data: dict[str, object] = {
        "member_name": member_name,
        "workspace_name": workspace_name,
        "description": scaffold_data.get("description") or _DEFAULT_MEMBER_DESCRIPTION,
        "org": org,
        "license": scaffold_data["license"],
        "license_holder": license_holder or org,
        "author_name": scaffold_data["author_name"],
        "author_email": scaffold_data["author_email"],
    }
    if private is not None:
        data["private"] = private
    return data

`read_workspace_name(workspace_root)`

Read the workspace name from pyproject.toml or fall back to dir name.

Source code in packages/axm-init/src/axm_init/core/scaffolder.py

Python
def read_workspace_name(workspace_root: Path) -> str:
    """Read the workspace name from ``pyproject.toml`` or fall back to dir name."""
    root_pyproject = workspace_root / "pyproject.toml"
    if root_pyproject.is_file():
        with open(root_pyproject, "rb") as f:
            root_data = tomllib.load(f)
        return str(root_data.get("project", {}).get("name", workspace_root.name))
    return workspace_root.name

`resolve_workspace_root(target_path)`

Resolve the workspace root for target_path, or None.

Returns target_path itself when it is a workspace root, the parent workspace root when target_path is a member, and None otherwise.

Source code in packages/axm-init/src/axm_init/core/scaffolder.py

Python
def resolve_workspace_root(target_path: Path) -> Path | None:
    """Resolve the workspace root for *target_path*, or ``None``.

    Returns *target_path* itself when it is a workspace root, the parent
    workspace root when *target_path* is a member, and ``None`` otherwise.
    """
    from axm_init.checks._workspace import (
        ProjectContext,
        detect_context,
        find_workspace_root,
    )

    context = detect_context(target_path)
    if context == ProjectContext.WORKSPACE:
        return target_path
    if context == ProjectContext.MEMBER:
        return find_workspace_root(target_path)
    return None