depozit-python

Python client for Depozit — a self-hosted file storage service.

Install

pip install depozit

Server

depozit server install    # clone & run install.sh from depozit-server
depozit server uninstall  # stop service and remove binaries

Manage the running service:

depozit start
depozit stop
depozit status

Usage

import depozit

default = depozit.connect("localhost:50051", api_key="your-api-key") # container default

default.upload("photo.jpg", "images/photo.jpg")        # upload a file
default.upload_bytes(b"hello", "notes/hello.txt")      # upload raw bytes

data = default.read("images/photo.jpg")                # read a file

default.rename("notes/hello.txt", "greet.txt")         # rename
default.delete("images/photo.jpg")                     # delete

for path in default.find(prefix="images/"):            # list files
    print(path)

Containers

Each connection is bound to one container. connect creates the container if it does not exist.

uploads = depozit.connect("localhost:50051", api_key="your-api-key", container="uploads")
uploads.upload_bytes(b"hello", "hello.txt")            # stored in "uploads"
uploads.close()

Only a client on the default container can manage containers. On any other container these methods raise PermissionError.

default = depozit.connect("localhost:50051", api_key="your-api-key")

default.create_container("backups")
default.rename_container("backups", "archive")
default.delete_container("archive")

Use with to close the connection automatically:

with depozit.connect("localhost:50051", api_key="your-api-key", container="uploads") as uploads:
    uploads.read("hello.txt")

Async

import depozit.aio

async with await depozit.aio.connect("localhost:50051", api_key="your-api-key") as default:
    data = await default.read("images/photo.jpg")