FastAPI Extension implementing the Tus.io server protocol
Installation from PyPi repository (recommended for latest stable release)
pip install tuspyserver
from fastapi import FastAPI
from starlette.middleware.cors import CORSMiddleware
from starlette.staticfiles import StaticFiles
from tusserver.tus import create_api_router
app = FastAPI()
app.add_middleware(
CORSMiddleware,
allow_origins=['*'],
allow_methods=["*"],
allow_headers=["*"],
)
app.mount("/static", StaticFiles(directory="static"), name="static")
def on_upload_complete(file_path: str, metadata: dict):
print('Upload complete')
print(file_path)
print('Upload Metadata')
print(metadata)
app.include_router(
create_api_router(
files_dir='/tmp/different_dir', # OPTIONAL
max_size=128849018880, # OPTIONAL
on_upload_complete=on_upload_complete, # OPTIONAL
prefix="files"
),
)This package has the ability to upload, download, delete (including a scheduler) files.
python setup.py sdist bdist_wheel
Reminder: Before pushing changes to the main branch, ensure that you increment the version number in setup.py according to the nature of your changes:
- Patch version for minor bug fixes.
- Minor version for new features or significant improvements.
- Major version for breaking changes.
After committing your changes to the main branch, create a Pull Request (PR) to merge main into the production branch. Once merged, the package will automatically be published to PyPI via the configured CI/CD workflow.
Any contribution is welcomed.
