Framework for Python

Cloud

cloud_login()

Connect this machine to a Framework Cloud server.

The token is stored per server in the system keyring (the same entry R and fw use), or in a file readable only by you when no keyring is available. The server becomes your default.

Usage

cloud_login(
    token: str,
    url: str | None = None,
    verify: bool = True,
    consent: bool | None = None,
) -> str

Arguments

Name Type Default Description
token required str

A personal token from the server's token page.

url str | None None

The server. Default: FW_CLOUD_URL, then your saved default, then https://framework.pub.

verify bool True

Check the token with the server first.

consent bool | None None

True to confirm without a prompt (scripts, CI).

Value

Where the token was stored: "keyring" or a file path.