Skip to content

File Manager

Upload, download, and delete files (product pictures, recipe pictures, equipment manuals, etc.).

Access via grocy.files.

# Upload a file
with open("photo.jpg", "rb") as f:
    grocy.files.upload(group="productpictures", file_name="photo.jpg", data=f)

# Download a file
data = grocy.files.download(group="productpictures", file_name="photo.jpg")

# Delete a file
grocy.files.delete(group="productpictures", file_name="photo.jpg")

Class Reference

FileManager(api_client)

Manage file uploads and downloads in Grocy.

Access via grocy.files.

upload(group, file_name, data)

Upload a file.

Parameters:

Name Type Description Default
group str

File group (e.g. "recipepictures").

required
file_name str

Name for the file in Grocy.

required
data

File content as bytes or a file-like object.

required

download(group, file_name)

Download a file.

Parameters:

Name Type Description Default
group str

File group (e.g. "recipepictures").

required
file_name str

Name of the file in Grocy.

required

delete(group, file_name)

Delete a file.

Parameters:

Name Type Description Default
group str

File group (e.g. "recipepictures").

required
file_name str

Name of the file in Grocy.

required