firebase.storage package

A simple python wrapper for Google’s Firebase Cloud Storage REST API

class firebase.storage.Storage(credentials, requests, storage_bucket)

Bases: object

Firebase Cloud Storage Service

Parameters

• credentials (Credentials) – Service Account Credentials.

• requests (Session) – Session to make HTTP requests.

• storage_bucket (str) – storageBucket from Firebase configuration.

child(*args)

Build paths to your storage.

Parameters

args (str) – Positional arguments to build path to storage.

Returns

A reference to the instance object.

Return type

Storage

delete(token=None)

Delete file from storage.

For more details:

Firebase Documentation | Delete files with Cloud Storage on Web

Parameters

token (str) – (Optional) Firebase Auth User ID Token, defaults to None.

download(filename, token=None)

Download file from storage.

For more details:

Firebase Documentation | Download files with Cloud Storage on Web

Parameters

• filename (str) – File name to be downloaded as.

• token (str) – (Optional) Firebase Auth User ID Token, defaults to None.

get_url(token=None, expiration_hour=24)

Fetches URL for file.

Parameters

• token (str) – (Optional) Firebase Auth User ID Token, defaults to None.

• expiration_hour (int) – (Optional) time in hour for URL to expire after, defaults to 24 hours. Works only for links generated with admin credentials.

Returns

URL for the file.

Return type

str

list_files()

List of all files in storage.

for more details:

Firebase Documentation | List files with Cloud Storage on Web

Returns

list of Blob

Return type

_BlobIterator

put(file, token=None)

Upload file to storage.

For more details:

Firebase Documentation | Upload files with Cloud Storage on Web

Parameters

• file (str) – Local path to file to upload.

• token (str) – (Optional) Firebase Auth User ID Token, defaults to None.

Returns

Successful attempt returns None.

Return type

None