API Reference¶

Deploying¶

schlepper.deploy(directory: str | Path, *, project_name: str, account_id: str, credentials: Credentials, branch: str | None = None, commit_hash: str | None = None, commit_message: str | None = None, commit_dirty: bool | None = None) → Deployment[source]¶

Deploy a directory of static assets to Cloudflare Pages.

This is the primary entry point for the library. At minimum you need to supply the directory to deploy, a project_name, an account_id, and credentials.

Returns a Deployment describing the result once the deployment reaches a terminal state.

Parameters:

directory (str | Path)
project_name (str)
account_id (str)
credentials (Credentials)
branch (str | None)
commit_hash (str | None)
commit_message (str | None)
commit_dirty (bool | None)

Return type:

Deployment

Credentials¶

class schlepper.ApiToken(token: str)[source]¶

Bases: object

Cloudflare API token credentials.

Parameters:: token (str)

token: str¶

class schlepper.ApiKey(key: str, email: str)[source]¶

Bases: object

Cloudflare global API key + email credentials.

Parameters:

key (str)
email (str)

key: str¶

email: str¶

Results¶

class schlepper.Deployment(id: str, url: str, environment: str, project_name: str, aliases: list[str] = <factory>, status: str = 'unknown')[source]¶

Bases: object

Result of a Cloudflare Pages deployment.

Parameters:

id (str)
url (str)
environment (str)
project_name (str)
aliases (list[str])
status (str)

id: str¶: Deployment identifier.

url: str¶: URL where the deployment is accessible.

environment: str¶: "production" or "preview".

project_name: str¶: Name of the Pages project.

aliases: list[str]¶: Alternative URLs (e.g. *.pages.dev aliases).

status: str¶: Terminal status: "success", "failure", or "unknown".

Exceptions¶

exception schlepper.SchlepperError[source]¶

Bases: Exception

Base exception for all schlepper errors.

exception schlepper.AuthenticationError[source]¶

Bases: SchlepperError

Raised when authentication fails or credentials are missing.

exception schlepper.APIError(message: str, *, status: int, code: int | None = None, errors: list[dict[str, object]] | None = None)[source]¶