TuspyServer

4.2.3 · active · verified Wed Apr 15

TuspyServer is a Python library implementing the tus.io resumable upload protocol as a FastAPI router. It provides flexible backend storage options, including local disk (DiskStorage) and AWS S3 (S3Storage). The current version is 4.2.3, and it's actively maintained with regular updates and feature enhancements.

Warnings

breaking Major refactor in v4.0.0 removed old storage implementations (e.g., `FileStorage`, `MemoryStorage`). Users must migrate to the new `DiskStorage` or `S3Storage` classes.
Fix: Replace imports like `from tuspyserver.storage import FileStorage` with `from tuspyserver import DiskStorage` and instantiate `DiskStorage` or `S3Storage` instead.
breaking Python 3.7 support was dropped in v3.0.0. The library now requires Python 3.8 or newer for compatibility.
Fix: Upgrade your Python environment to 3.8 or a later version to use `tuspyserver` v3.0.0 or higher.
gotcha When using `S3Storage`, the `boto3` library is a conditional dependency and must be installed explicitly using `pip install tuspyserver[s3]`.
Fix: Ensure `pip install tuspyserver[s3]` is executed if planning to utilize AWS S3 for file storage, as `boto3` is not included in the base installation.
gotcha The `tuspyserver` integrates as a FastAPI router, meaning your application needs to be run using an ASGI server like Uvicorn. While `uvicorn` is a dependency, you still need to know how to execute it.
Fix: After creating your FastAPI application (e.g., in `main.py`), run it using `uvicorn main:app --reload` in your terminal for development.

Install

pip install tuspyserver Base installation
pip install tuspyserver[s3] With S3 storage support

Imports

TuspyServer
```
from tuspyserver import TuspyServer
```
DiskStorage
wrong:
```
from tuspyserver.storage import FileStorage
```
correct:
```
from tuspyserver import DiskStorage
```
Old storage classes like `FileStorage` were removed in v4.x. Use `DiskStorage` or `S3Storage` instead.
S3Storage
```
from tuspyserver import S3Storage
```

Quickstart

This quickstart sets up a basic `tuspyserver` instance with `DiskStorage` using FastAPI. It initializes the storage, ensures the upload directory exists, integrates the `TuspyServer` router into the FastAPI application under the `/files` prefix, and includes an example endpoint to list uploaded files. Remember to install `uvicorn` and run the app with `uvicorn main:app`.

import os
from fastapi import FastAPI
from tuspyserver import TuspyServer, DiskStorage

app = FastAPI()

# Ensure the upload directory exists for DiskStorage
upload_dir = os.path.join(os.getcwd(), "upload_data")
os.makedirs(upload_dir, exist_ok=True)

# Initialize DiskStorage. For S3Storage, use: 
# S3Storage(
#     bucket_name=os.environ.get('S3_BUCKET_NAME', 'your-s3-bucket'),
#     aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
#     aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', ''),
#     # region_name=os.environ.get('AWS_REGION', 'us-east-1')
# )
storage = DiskStorage(upload_dir)

# Initialize TuspyServer with the chosen storage backend
tus_server = TuspyServer(storage)

# Add the TuspyServer router to your FastAPI app
app.include_router(tus_server.router, prefix="/files")

# Optional: Add an endpoint to list uploaded files (for demonstration)
@app.get("/uploaded-files")
async def list_files():
    return storage.list_files()

# To run this app, save it as main.py and execute:
# uvicorn main:app --reload --port 8000

view raw JSON →