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
Python
 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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: object) -> 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.
        """
        name_raw = kwargs.get("name")
        if not isinstance(name_raw, str) or not name_raw:
            return ToolResult(success=False, error="'name' is required")
        name: str = name_raw
        author_raw = kwargs.get("author", "")
        email_raw = kwargs.get("email", "")
        dry_run_raw = kwargs.get("dry_run", False)
        author: str = author_raw if isinstance(author_raw, str) else ""
        email: str = email_raw if isinstance(email_raw, str) else ""
        if not isinstance(dry_run_raw, bool):
            return ToolResult(
                success=False,
                error=(
                    f"'dry_run' must be a boolean, got {type(dry_run_raw).__name__}"
                ),
            )
        dry_run: bool = dry_run_raw

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

        try:
            from axm_init.adapters.credentials import CredentialManager
            from axm_init.adapters.pypi import PyPIAdapter
            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,
                checker=PyPIAdapter(),
            )

            return ToolResult(
                success=result.success,
                data={
                    "package_name": result.package_name,
                    "version": result.version,
                    "message": result.message,
                },
                text=(
                    _render_reserve_text(
                        result.package_name, result.version, result.message
                    )
                    if result.success
                    else None
                ),
                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 object

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
Python
 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def execute(self, **kwargs: object) -> 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.
    """
    name_raw = kwargs.get("name")
    if not isinstance(name_raw, str) or not name_raw:
        return ToolResult(success=False, error="'name' is required")
    name: str = name_raw
    author_raw = kwargs.get("author", "")
    email_raw = kwargs.get("email", "")
    dry_run_raw = kwargs.get("dry_run", False)
    author: str = author_raw if isinstance(author_raw, str) else ""
    email: str = email_raw if isinstance(email_raw, str) else ""
    if not isinstance(dry_run_raw, bool):
        return ToolResult(
            success=False,
            error=(
                f"'dry_run' must be a boolean, got {type(dry_run_raw).__name__}"
            ),
        )
    dry_run: bool = dry_run_raw

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

    try:
        from axm_init.adapters.credentials import CredentialManager
        from axm_init.adapters.pypi import PyPIAdapter
        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,
            checker=PyPIAdapter(),
        )

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