Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions qfieldcloud_sdk/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,26 @@ def delete_project(ctx: Context, project_id):
log(f'Deleted project "{project_id}".')


@cli.command()
@click.argument("project_id")
@click.argument(
"local_filename",
type=click.Path(exists=True, file_okay=True, dir_okay=False, readable=True),
)
@click.pass_context
def upload_project_thumbnail(
ctx: Context, project_id: str, local_filename: str
) -> None:
"""Upload a project thumbnail."""

response = ctx.obj["client"].upload_project_thumbnail(project_id, local_filename)

if ctx.obj["format_json"]:
print_json(response)
else:
log(f'Uploaded thumbnail "{local_filename}" to project "{project_id}".')


@cli.command()
@click.argument("project_id")
@click.argument("project_path")
Expand Down
35 changes: 35 additions & 0 deletions qfieldcloud_sdk/sdk.py
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,41 @@ def patch_project(

return resp.json()

def upload_project_thumbnail(
self,
project_id: str,
local_filename: str,
) -> requests.Response:
"""Upload a project thumbnail.

Args:
project_id: Project ID.
local_filename: Path to the thumbnail image file.

Raises:
pathvalidate.ValidationError: Raised when the uploaded file does not have a valid filename.

Returns:
The response object from the upload request.

Example:
```python
client.upload_project_thumbnail(
project_id="123e4567-e89b-12d3-a456-426614174000",
local_filename="thumbnail.png"
)
```
"""
# if the filepath is invalid, it will throw a new error `pathvalidate.ValidationError`
is_valid_filepath(local_filename)

with open(local_filename, "rb") as thumbnail:
return self._request(
"POST",
f"projects/{project_id}/thumbnail",
files={"thumbnail": thumbnail},
)

def upload_files(
self,
project_id: str,
Expand Down