Skip to content

Reserve

reserve

InitReserveTool — reserve a PyPI package name as an AXMTool.

InitReserveTool

Reserve a package name on PyPI.

Registered as init_reserve via axm.tools entry point.

Source code in packages/axm-init/src/axm_init/tools/reserve.py 
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class InitReserveTool:
    """Reserve a package name on PyPI.

    Registered as ``init_reserve`` via axm.tools entry point.
    """

    @property
    def name(self) -> str:
        """Tool name used for MCP registration."""
        return "init_reserve"

    def execute(self, **kwargs: Any) -> ToolResult:
        """Reserve a package name on PyPI.

        Args:
            **kwargs: Keyword arguments.
                name: Package name to reserve.
                author: Author name for the placeholder package.
                email: Author email for the placeholder package.
                dry_run: If True, skip the actual publish step.

        Returns:
            ToolResult with reservation status.
        """
        if "name" not in kwargs:
            return ToolResult(success=False, error="'name' is required")
        name: str = kwargs["name"]
        author: str = kwargs.get("author", "")
        email: str = kwargs.get("email", "")
        dry_run: bool = kwargs.get("dry_run", False)

        error = _validate_identity(author, email)
        if error:
            return error

        try:
            from axm_init.adapters.credentials import CredentialManager
            from axm_init.core.reserver import reserve_pypi

            creds = CredentialManager()

            if not dry_run:
                token = creds.get_pypi_token()
                if not token:
                    return ToolResult(
                        success=False,
                        error=(
                            "No PyPI token found. Set PYPI_TOKEN or configure keyring."
                        ),
                    )
            else:
                token = creds.get_pypi_token() or ""

            result = reserve_pypi(
                name=name,
                author=author,
                email=email,
                token=token or "",
                dry_run=dry_run,
            )

            return ToolResult(
                success=result.success,
                data={
                    "package_name": result.package_name,
                    "version": result.version,
                    "message": result.message,
                },
                error=None if result.success else result.message,
            )
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Tool name used for MCP registration.

execute(**kwargs)

Reserve a package name on PyPI.

Parameters:

Name Type Description Default
**kwargs Any

Keyword arguments. name: Package name to reserve. author: Author name for the placeholder package. email: Author email for the placeholder package. dry_run: If True, skip the actual publish step.

 {}

Returns:

Type Description
ToolResult

ToolResult with reservation status.
Source code in packages/axm-init/src/axm_init/tools/reserve.py 
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def execute(self, **kwargs: Any) -> ToolResult:
    """Reserve a package name on PyPI.

    Args:
        **kwargs: Keyword arguments.
            name: Package name to reserve.
            author: Author name for the placeholder package.
            email: Author email for the placeholder package.
            dry_run: If True, skip the actual publish step.

    Returns:
        ToolResult with reservation status.
    """
    if "name" not in kwargs:
        return ToolResult(success=False, error="'name' is required")
    name: str = kwargs["name"]
    author: str = kwargs.get("author", "")
    email: str = kwargs.get("email", "")
    dry_run: bool = kwargs.get("dry_run", False)

    error = _validate_identity(author, email)
    if error:
        return error

    try:
        from axm_init.adapters.credentials import CredentialManager
        from axm_init.core.reserver import reserve_pypi

        creds = CredentialManager()

        if not dry_run:
            token = creds.get_pypi_token()
            if not token:
                return ToolResult(
                    success=False,
                    error=(
                        "No PyPI token found. Set PYPI_TOKEN or configure keyring."
                    ),
                )
        else:
            token = creds.get_pypi_token() or ""

        result = reserve_pypi(
            name=name,
            author=author,
            email=email,
            token=token or "",
            dry_run=dry_run,
        )

        return ToolResult(
            success=result.success,
            data={
                "package_name": result.package_name,
                "version": result.version,
                "message": result.message,
            },
            error=None if result.success else result.message,
        )
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))