tuspyserver 2.2.2__tar.gz → 3.0.0__tar.gz

tuspyserver-3.0.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.3
+Name: tuspyserver
+Version: 3.0.0
+Summary: A Python tus server implementation as a FastAPI router
+Author: Edi Hasaj
+Author-email: Edi Hasaj <edi.hasaj@applifyer.com>
+Requires-Dist: fastapi>=0.110.0
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+<a href="https://pypi.org/project/tuspyserver/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/tuspyserver" align="right"></a>
+
+# tuspyserver
+
+A FastAPI router implementing a [tus upload protocol](https://tus.io/) server, with optional dependency-injected hooks for post-upload processing.
+
+Only depends on `fastapi>=0.110` and `python>=3.8`.
+
+## Features
+
+* **⏸️ Resumable uploads** via TUS protocol
+* **🍰 Chunked transfer** with configurable max size
+* **🗃️ Metadata storage** (filename, filetype)
+* **🧹 Expiration & cleanup** of old uploads (default retention: 5 days)
+* **💉 Dependency injection** for seamless validation (optional)
+* **📡 Comprehensive API** with *download*, *HEAD*, *DELETE*, and *OPTIONS* endpoints
+
+## Installation
+
+Install the [latest release from PyPI](https://pypi.org/project/tuspyserver/):
+
+```bash
+# with uv
+uv add tuspyserver
+# with poetry
+poetry add tuspyserver
+# with pip
+pip install tuspyserver
+```
+
+Or install directly from source:
+
+```bash
+git clone https://github.com/edihasaj/tuspyserver
+cd tuspyserver
+pip install .
+```
+
+## Usage
+
+### API
+
+The main API is a single constructor that initializes the tus router. All arguments are optional, and these are their default values:
+
+```python
+from tuspyserver import create_tus_router
+
+tus_router = create_tus_router(
+    prefix="files",                                   # route prefix (default: 'files')
+    files_dir="/tmp/files",                  # path to store files
+    max_size=128_849_018_880,             # max upload size in bytes (default is ~128GB)
+    auth=noop,                                              # authentication dependency
+    days_to_keep=5,                                   # retention period
+    on_upload_complete=None,               # upload callback
+    upload_complete_dep=None,             # upload callback (dependency injector)
+)
+```
+
+### Basic setup
+
+In your `main.py`:
+
+```python
+from tuspyserver import create_tus_router
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.staticfiles import StaticFiles
+
+import uvicorn
+
+# initialize a FastAPI app
+app = FastAPI()
+
+# configure cross-origin middleware
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_methods=["*"],
+    allow_headers=["*"],
+    expose_headers=[
+        "Location",
+        "Upload-Offset",
+        "Tus-Resumable",
+        "Tus-Version",
+        "Tus-Extension",
+        "Tus-Max-Size",
+        "Upload-Expires",
+    ],
+)
+
+# use completion hook to log uploads
+def log_upload(file_path: str, metadata: dict):
+    print("Upload complete")
+    print(file_path)
+    print(metadata)
+
+
+# mount the tus router to our
+app.include_router(
+    create_tus_router(
+        files_dir="./uploads",
+        on_upload_complete=log_upload,
+    )
+)
+```
+
+>[!IMPORTANT]
+>Headers must be exposed for chunked uploads to work correctly.
+
+For a comprehensive working example, see the [tuspyserver example](#example).
+
+### Dependency injection
+
+For applications using FastAPI's [dependency injection](https://fastapi.tiangolo.com/tutorial/dependencies/), you can supply a factory function that returns a callback with injected dependencies. The factory can `Depends()` on any of your services (database session, current user, etc.).
+
+```python
+# Define a factory dependency that injects your own services
+from fastapi import Depends
+from your_app.dependencies import get_db, get_current_user
+
+# factory function
+def log_user_upload(
+    db=Depends(get_db),
+    current_user=Depends(get_current_user),
+) -> Callable[[str, dict], None]:
+    # callback function
+    async def handler(file_path: str, metadata: dict):
+        # perform validation or post-processing
+        await db.log_upload(current_user.id, metadata)
+        await process_file(file_path)
+    return handler
+
+# Include router with the DI hook
+app.include_router(
+    create_api_router(
+        upload_complete_dep=log_user_upload,
+    )
+)
+```
+
+### Expiration & cleanup
+
+Expired files are removed when `remove_expired_files()` is called. You can schedule it using your preferred background scheduler (e.g., `APScheduler`, `cron`).
+
+```python
+from tuspyserver import create_tus_router
+
+from apscheduler.schedulers.background import BackgroundScheduler
+
+tus_router = create_tus_router(
+    days_to_keep = 23  # configure retention period; defaults to 5 days
+)
+
+scheduler = BackgroundScheduler()
+scheduler.add_job(
+    lambda: tus_router.remove_expired_files(),
+    trigger='cron',
+    hour=1,
+)
+scheduler.start()
+```
+
+## Example
+
+You can find a complete working basic example in the [examples](https://github/edihasaj/tuspyserver/tree/main/examples) folder.
+
+The example consists of the following:
+
+```bash
+basic.py           # backend: a tus router added to a fastapi app and runs it with uvicorn
+static/index.html  # frontend: a simple static HTML file using uppy (based on tus-js-client)
+```
+
+To run it, you need to install [`uv`](https://docs.astral.sh/uv/) and run:
+```bash
+uv run basic.py
+```
+
+This should launch the server, and you should now be able to test uploads by browsing to http://localhost:8000/static/index.html.
+
+Uploaded files get placed in the `examples/uploads` folder.
+
+## Developing
+
+Contributions welcome! Please open issues or PRs on [GitHub](https://github.com/edihasaj/tuspyserver).
+
+You need [`uv`](https://docs.astral.sh/uv/) to develop the project. The project is setup as a [uv workspace](https://docs.astral.sh/uv/concepts/projects/workspaces/)
+where the root is the [library](https://docs.astral.sh/uv/concepts/projects/init/#libraries) and the examples directory is an [unpackagedapplication](https://docs.astral.sh/uv/concepts/projects/init/#applications)
+
+### Releasing
+
+To release the package, follow the following steps:
+
+1. Update the version in `pyproject.toml` using [semver](https://semver.org/)
+2. Merge PR to main or push directly to main
+3. Open a PR to merge `main` → `production`.
+4. Upon merge, CI/CD will publish to PyPI.
+
+
+*© 2025 Edi Hasaj [X](https://x.com/hasajedi)*

tuspyserver-3.0.0/README.md

@@ -0,0 +1,201 @@
+<a href="https://pypi.org/project/tuspyserver/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/tuspyserver" align="right"></a>
+
+# tuspyserver
+
+A FastAPI router implementing a [tus upload protocol](https://tus.io/) server, with optional dependency-injected hooks for post-upload processing.
+
+Only depends on `fastapi>=0.110` and `python>=3.8`.
+
+## Features
+
+* **⏸️ Resumable uploads** via TUS protocol
+* **🍰 Chunked transfer** with configurable max size
+* **🗃️ Metadata storage** (filename, filetype)
+* **🧹 Expiration & cleanup** of old uploads (default retention: 5 days)
+* **💉 Dependency injection** for seamless validation (optional)
+* **📡 Comprehensive API** with *download*, *HEAD*, *DELETE*, and *OPTIONS* endpoints
+
+## Installation
+
+Install the [latest release from PyPI](https://pypi.org/project/tuspyserver/):
+
+```bash
+# with uv
+uv add tuspyserver
+# with poetry
+poetry add tuspyserver
+# with pip
+pip install tuspyserver
+```
+
+Or install directly from source:
+
+```bash
+git clone https://github.com/edihasaj/tuspyserver
+cd tuspyserver
+pip install .
+```
+
+## Usage
+
+### API
+
+The main API is a single constructor that initializes the tus router. All arguments are optional, and these are their default values:
+
+```python
+from tuspyserver import create_tus_router
+
+tus_router = create_tus_router(
+    prefix="files",                                   # route prefix (default: 'files')
+    files_dir="/tmp/files",                  # path to store files
+    max_size=128_849_018_880,             # max upload size in bytes (default is ~128GB)
+    auth=noop,                                              # authentication dependency
+    days_to_keep=5,                                   # retention period
+    on_upload_complete=None,               # upload callback
+    upload_complete_dep=None,             # upload callback (dependency injector)
+)
+```
+
+### Basic setup
+
+In your `main.py`:
+
+```python
+from tuspyserver import create_tus_router
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.staticfiles import StaticFiles
+
+import uvicorn
+
+# initialize a FastAPI app
+app = FastAPI()
+
+# configure cross-origin middleware
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_methods=["*"],
+    allow_headers=["*"],
+    expose_headers=[
+        "Location",
+        "Upload-Offset",
+        "Tus-Resumable",
+        "Tus-Version",
+        "Tus-Extension",
+        "Tus-Max-Size",
+        "Upload-Expires",
+    ],
+)
+
+# use completion hook to log uploads
+def log_upload(file_path: str, metadata: dict):
+    print("Upload complete")
+    print(file_path)
+    print(metadata)
+
+
+# mount the tus router to our
+app.include_router(
+    create_tus_router(
+        files_dir="./uploads",
+        on_upload_complete=log_upload,
+    )
+)
+```
+
+>[!IMPORTANT]
+>Headers must be exposed for chunked uploads to work correctly.
+
+For a comprehensive working example, see the [tuspyserver example](#example).
+
+### Dependency injection
+
+For applications using FastAPI's [dependency injection](https://fastapi.tiangolo.com/tutorial/dependencies/), you can supply a factory function that returns a callback with injected dependencies. The factory can `Depends()` on any of your services (database session, current user, etc.).
+
+```python
+# Define a factory dependency that injects your own services
+from fastapi import Depends
+from your_app.dependencies import get_db, get_current_user
+
+# factory function
+def log_user_upload(
+    db=Depends(get_db),
+    current_user=Depends(get_current_user),
+) -> Callable[[str, dict], None]:
+    # callback function
+    async def handler(file_path: str, metadata: dict):
+        # perform validation or post-processing
+        await db.log_upload(current_user.id, metadata)
+        await process_file(file_path)
+    return handler
+
+# Include router with the DI hook
+app.include_router(
+    create_api_router(
+        upload_complete_dep=log_user_upload,
+    )
+)
+```
+
+### Expiration & cleanup
+
+Expired files are removed when `remove_expired_files()` is called. You can schedule it using your preferred background scheduler (e.g., `APScheduler`, `cron`).
+
+```python
+from tuspyserver import create_tus_router
+
+from apscheduler.schedulers.background import BackgroundScheduler
+
+tus_router = create_tus_router(
+    days_to_keep = 23  # configure retention period; defaults to 5 days
+)
+
+scheduler = BackgroundScheduler()
+scheduler.add_job(
+    lambda: tus_router.remove_expired_files(),
+    trigger='cron',
+    hour=1,
+)
+scheduler.start()
+```
+
+## Example
+
+You can find a complete working basic example in the [examples](https://github/edihasaj/tuspyserver/tree/main/examples) folder.
+
+The example consists of the following:
+
+```bash
+basic.py           # backend: a tus router added to a fastapi app and runs it with uvicorn
+static/index.html  # frontend: a simple static HTML file using uppy (based on tus-js-client)
+```
+
+To run it, you need to install [`uv`](https://docs.astral.sh/uv/) and run:
+```bash
+uv run basic.py
+```
+
+This should launch the server, and you should now be able to test uploads by browsing to http://localhost:8000/static/index.html.
+
+Uploaded files get placed in the `examples/uploads` folder.
+
+## Developing
+
+Contributions welcome! Please open issues or PRs on [GitHub](https://github.com/edihasaj/tuspyserver).
+
+You need [`uv`](https://docs.astral.sh/uv/) to develop the project. The project is setup as a [uv workspace](https://docs.astral.sh/uv/concepts/projects/workspaces/)
+where the root is the [library](https://docs.astral.sh/uv/concepts/projects/init/#libraries) and the examples directory is an [unpackagedapplication](https://docs.astral.sh/uv/concepts/projects/init/#applications)
+
+### Releasing
+
+To release the package, follow the following steps:
+
+1. Update the version in `pyproject.toml` using [semver](https://semver.org/)
+2. Merge PR to main or push directly to main
+3. Open a PR to merge `main` → `production`.
+4. Upon merge, CI/CD will publish to PyPI.
+
+
+*© 2025 Edi Hasaj [X](https://x.com/hasajedi)*

tuspyserver-3.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "tuspyserver"
+version = "3.0.0"
+description ="A Python tus server implementation as a FastAPI router"
+readme = "README.md"
+authors = [
+    { name = "Edi Hasaj", email = "edi.hasaj@applifyer.com" }
+]
+requires-python = ">=3.8"
+dependencies = [    
+    "fastapi>=0.110.0"
+]
+
+[build-system]
+requires = ["uv_build>=0.6,<0.7"]
+build-backend = "uv_build"
+
+
+[tool.uv.workspace]
+members = [
+    "examples",
+]

tuspyserver-3.0.0/src/tuspyserver/__init__.py

@@ -0,0 +1,4 @@
+from tuspyserver.router import create_tus_router
+from tuspyserver.metadata import FileMetadata
+
+__all__ = ["create_tus_router", "FileMetadata"]

tuspyserver-2.2.2/tusserver/tus.py → tuspyserver-3.0.0/src/tuspyserver/router.py

@@ -18,20 +18,20 @@ from fastapi import (
 )
 from starlette.responses import FileResponse
 
-from tusserver.metadata import FileMetadata
+from tuspyserver.metadata import FileMetadata
 
 
-async def default_auth():
+async def noop():
     pass
 
 
-def create_api_router(
+def create_tus_router(
+    prefix: str = "files",
     files_dir="/tmp/files",
     max_size=128849018880,
-    on_upload_complete: Optional[Callable[[str, dict], None]] = None,
-    auth: Optional[Callable[[], None]] = default_auth,
+    auth: Optional[Callable[[], None]] = noop,
     days_to_keep: int = 5,
-    prefix: str = "files",
+    on_upload_complete: Optional[Callable[[str, dict], None]] = None,
     upload_complete_dep: Optional[Callable[..., Callable[[str, dict], None]]] = None,
 ):
     if prefix and prefix[0] == "/":
@@ -357,10 +357,4 @@ def create_api_router(
         proto, host = _get_host_and_proto(request=request)
         return f"{proto}://{host}/{prefix}/{uuid}"
 
-    # # Create a scheduler for deleting the files
-    # scheduler = sched.scheduler(time.time, time.sleep)
-    # run_time = time.mktime(time.strptime("01:00", "%H:%M"))
-    # scheduler.enterabs(run_time, 1, remove_expired_files)
-    # scheduler.run()
-
     return router

tuspyserver-2.2.2/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Tus Server for FastAPI Python
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

tuspyserver-2.2.2/PKG-INFO

@@ -1,183 +0,0 @@
-Metadata-Version: 2.1
-Name: tuspyserver
-Version: 2.2.2
-Summary: TUS py protocol implementation in FastAPI
-Home-page: https://github.com/edihasaj/tuspy-fast-api
-Author: Edi Hasaj
-Author-email: edi.hasaj@applifyer.com
-License: MIT
-Platform: any
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# FastAPI Tus
-
-A FastAPI extension implementing the [Tus.io](https://tus.io/) upload protocol, with optional dependency-injected hooks for post-upload processing.
-
-## Prerequisites
-
-* **Python** 3.8+
-* **FastAPI** 0.70+
-* **Starlette** (installed as FastAPI dependency)
-
-## Installation
-
-Install the latest stable release from PyPI:
-
-```bash
-pip install tuspyserver
-```
-
-Or install directly from source:
-
-```bash
-git clone https://github.com/edihasaj/tuspy-fast-api
-cd tuspy-fast-api
-pip install .
-```
-
-## Usage
-
-### Basic setup
-
-In your `main.py`:
-
-```python
-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=["*"],
-    expose_headers=[
-     "Location",
-     "Upload-Offset",
-     "Tus-Resumable",
-     "Tus-Version",
-     "Tus-Extension",
-     "Tus-Max-Size",
-     "Upload-Expires",
-    ],
-)
-app.mount("/static", StaticFiles(directory="static"), name="static")
-
-# Optional: define a simple completion hook
-def on_upload_complete(file_path: str, metadata: dict):
-    print("Upload complete:", file_path)
-    print("Metadata:", metadata)
-
-# Include the router
-app.include_router(
-    create_api_router(
-        files_dir="/tmp/uploads",        # OPTIONAL: directory to store files
-        max_size=128_849_018_880,         # OPTIONAL: max upload size in bytes (~120GB)
-        on_upload_complete=on_upload_complete,  # OPTIONAL: callback when upload finishes
-        prefix="files",                 # OPTIONAL: URL prefix (default: 'files')
-    ),
-)
-
-```
-
-### !Warning If you include your own router then it is necessary that your app allows these Headers:
-
-```python
-app.add_middleware( 
-   CORSMiddleware, (# OPTIONAL: add CORS middleware if needed)
-   allow_origins=["*"], # OPTIONAL: allow all origins
-   allow_methods=["*"], # OPTIONAL: allow all methods
-   allow_headers=["*"], # OPTIONAL: allow all headers
-   expose_headers=[ # REQUIRED: expose these headers to the client
-    "Location",
-    "Upload-Offset",
-    "Tus-Resumable",
-    "Tus-Version",
-    "Tus-Extension",
-    "Tus-Max-Size",
-    "Upload-Expires",
-   ],
-)
-```
-
-### Dependency‑Injected Hook (Advanced)
-
-For applications using FastAPI's dependency injection, you can supply a factory that returns a DI‑enabled callback. This factory can `Depends()` on any of your services (database session, current user, etc.).
-
-```python
-# Define a factory dependency that injects your own services
-from fastapi import Depends
-from your_app.dependencies import get_db, get_current_user
-
-def get_upload_handler(
-    db=Depends(get_db),
-    current_user=Depends(get_current_user),
-) -> Callable[[str, dict], None]:
-    def handler(file_path: str, metadata: dict):
-        # perform validation or post-processing
-        db.log_upload(current_user.id, metadata)
-        process_file(file_path)
-    return handler
-
-# Include router with the DI hook
-app.include_router(
-    create_api_router(
-        on_upload_complete=None,            # keep default
-        upload_complete_dep=get_upload_handler,  # factory dependency
-    )
-)
-```
-
-### Features
-
-* **Resumable uploads** via TUS protocol
-* **Chunked transfer** with configurable max size
-* **Metadata storage** (filename, filetype)
-* **Expiration & cleanup** of old uploads (default retention: 5 days)
-* **Download**, **HEAD**, **DELETE**, and **OPTIONS** endpoints
-* **Optional** DI‑friendly `upload_complete_dep` for seamless integration with FastAPI
-
-## Scheduler (Cleanup)
-
-Expired files are removed when `remove_expired_files()` is called. You can schedule it using your preferred background scheduler (e.g., `APScheduler`, `cron`).
-
-```python
-from apscheduler.schedulers.background import BackgroundScheduler
-
-scheduler = BackgroundScheduler()
-scheduler.add_job(
-    lambda: router.remove_expired_files(),
-    trigger='cron',
-    hour=1,
-)
-scheduler.start()
-```
-
-## Versioning & Publishing
-
-**Before releasing:**
-
-1. Update the version in `setup.py`:
-
-   * **Patch** for bug fixes
-   * **Minor** for new features
-   * **Major** for breaking changes
-2. Commit and push to `main`.
-3. Open a PR to merge `main` → `production`.
-4. Upon merge, CI/CD will publish to PyPI.
-
-## Contributing
-
-Contributions welcome! Please open issues or PRs on [GitHub](https://github.com/edihasaj/tuspy-fast-api).
-
-*© 2025 Edi Hasaj [X](https://x.com/hasajedi)*

tuspyserver-2.2.2/README.md

@@ -1,165 +0,0 @@
-# FastAPI Tus
-
-A FastAPI extension implementing the [Tus.io](https://tus.io/) upload protocol, with optional dependency-injected hooks for post-upload processing.
-
-## Prerequisites
-
-* **Python** 3.8+
-* **FastAPI** 0.70+
-* **Starlette** (installed as FastAPI dependency)
-
-## Installation
-
-Install the latest stable release from PyPI:
-
-```bash
-pip install tuspyserver
-```
-
-Or install directly from source:
-
-```bash
-git clone https://github.com/edihasaj/tuspy-fast-api
-cd tuspy-fast-api
-pip install .
-```
-
-## Usage
-
-### Basic setup
-
-In your `main.py`:
-
-```python
-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=["*"],
-    expose_headers=[
-     "Location",
-     "Upload-Offset",
-     "Tus-Resumable",
-     "Tus-Version",
-     "Tus-Extension",
-     "Tus-Max-Size",
-     "Upload-Expires",
-    ],
-)
-app.mount("/static", StaticFiles(directory="static"), name="static")
-
-# Optional: define a simple completion hook
-def on_upload_complete(file_path: str, metadata: dict):
-    print("Upload complete:", file_path)
-    print("Metadata:", metadata)
-
-# Include the router
-app.include_router(
-    create_api_router(
-        files_dir="/tmp/uploads",        # OPTIONAL: directory to store files
-        max_size=128_849_018_880,         # OPTIONAL: max upload size in bytes (~120GB)
-        on_upload_complete=on_upload_complete,  # OPTIONAL: callback when upload finishes
-        prefix="files",                 # OPTIONAL: URL prefix (default: 'files')
-    ),
-)
-
-```
-
-### !Warning If you include your own router then it is necessary that your app allows these Headers:
-
-```python
-app.add_middleware( 
-   CORSMiddleware, (# OPTIONAL: add CORS middleware if needed)
-   allow_origins=["*"], # OPTIONAL: allow all origins
-   allow_methods=["*"], # OPTIONAL: allow all methods
-   allow_headers=["*"], # OPTIONAL: allow all headers
-   expose_headers=[ # REQUIRED: expose these headers to the client
-    "Location",
-    "Upload-Offset",
-    "Tus-Resumable",
-    "Tus-Version",
-    "Tus-Extension",
-    "Tus-Max-Size",
-    "Upload-Expires",
-   ],
-)
-```
-
-### Dependency‑Injected Hook (Advanced)
-
-For applications using FastAPI's dependency injection, you can supply a factory that returns a DI‑enabled callback. This factory can `Depends()` on any of your services (database session, current user, etc.).
-
-```python
-# Define a factory dependency that injects your own services
-from fastapi import Depends
-from your_app.dependencies import get_db, get_current_user
-
-def get_upload_handler(
-    db=Depends(get_db),
-    current_user=Depends(get_current_user),
-) -> Callable[[str, dict], None]:
-    def handler(file_path: str, metadata: dict):
-        # perform validation or post-processing
-        db.log_upload(current_user.id, metadata)
-        process_file(file_path)
-    return handler
-
-# Include router with the DI hook
-app.include_router(
-    create_api_router(
-        on_upload_complete=None,            # keep default
-        upload_complete_dep=get_upload_handler,  # factory dependency
-    )
-)
-```
-
-### Features
-
-* **Resumable uploads** via TUS protocol
-* **Chunked transfer** with configurable max size
-* **Metadata storage** (filename, filetype)
-* **Expiration & cleanup** of old uploads (default retention: 5 days)
-* **Download**, **HEAD**, **DELETE**, and **OPTIONS** endpoints
-* **Optional** DI‑friendly `upload_complete_dep` for seamless integration with FastAPI
-
-## Scheduler (Cleanup)
-
-Expired files are removed when `remove_expired_files()` is called. You can schedule it using your preferred background scheduler (e.g., `APScheduler`, `cron`).
-
-```python
-from apscheduler.schedulers.background import BackgroundScheduler
-
-scheduler = BackgroundScheduler()
-scheduler.add_job(
-    lambda: router.remove_expired_files(),
-    trigger='cron',
-    hour=1,
-)
-scheduler.start()
-```
-
-## Versioning & Publishing
-
-**Before releasing:**
-
-1. Update the version in `setup.py`:
-
-   * **Patch** for bug fixes
-   * **Minor** for new features
-   * **Major** for breaking changes
-2. Commit and push to `main`.
-3. Open a PR to merge `main` → `production`.
-4. Upon merge, CI/CD will publish to PyPI.
-
-## Contributing
-
-Contributions welcome! Please open issues or PRs on [GitHub](https://github.com/edihasaj/tuspy-fast-api).
-
-*© 2025 Edi Hasaj [X](https://x.com/hasajedi)*

tuspyserver-2.2.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

tuspyserver-2.2.2/setup.py

@@ -1,38 +0,0 @@
-"""
-FastAPI Tus implementation
--------------
-Implements the tus.io server-side file-upload protocol
-visit https://tus.io for more information
-"""
-
-from setuptools import find_packages, setup
-
-with open("README.md", "r") as f:
-    long_description = f.read()
-
-setup(
-    name="tuspyserver",
-    version="2.2.2",
-    description="TUS py protocol implementation in FastAPI",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author="Edi Hasaj",
-    license="MIT",
-    author_email="edi.hasaj@applifyer.com",
-    url="https://github.com/edihasaj/tuspy-fast-api",
-    packages=find_packages(),
-    platforms="any",
-    include_package_data=True,
-    install_requires=[
-        "fastapi>=0.110.0",
-        "pydantic>=2.6.2",
-    ],
-    classifiers=[
-        "Environment :: Web Environment",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-    ],
-)

tuspyserver-2.2.2/tuspyserver.egg-info/PKG-INFO

@@ -1,183 +0,0 @@
-Metadata-Version: 2.1
-Name: tuspyserver
-Version: 2.2.2
-Summary: TUS py protocol implementation in FastAPI
-Home-page: https://github.com/edihasaj/tuspy-fast-api
-Author: Edi Hasaj
-Author-email: edi.hasaj@applifyer.com
-License: MIT
-Platform: any
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# FastAPI Tus
-
-A FastAPI extension implementing the [Tus.io](https://tus.io/) upload protocol, with optional dependency-injected hooks for post-upload processing.
-
-## Prerequisites
-
-* **Python** 3.8+
-* **FastAPI** 0.70+
-* **Starlette** (installed as FastAPI dependency)
-
-## Installation
-
-Install the latest stable release from PyPI:
-
-```bash
-pip install tuspyserver
-```
-
-Or install directly from source:
-
-```bash
-git clone https://github.com/edihasaj/tuspy-fast-api
-cd tuspy-fast-api
-pip install .
-```
-
-## Usage
-
-### Basic setup
-
-In your `main.py`:
-
-```python
-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=["*"],
-    expose_headers=[
-     "Location",
-     "Upload-Offset",
-     "Tus-Resumable",
-     "Tus-Version",
-     "Tus-Extension",
-     "Tus-Max-Size",
-     "Upload-Expires",
-    ],
-)
-app.mount("/static", StaticFiles(directory="static"), name="static")
-
-# Optional: define a simple completion hook
-def on_upload_complete(file_path: str, metadata: dict):
-    print("Upload complete:", file_path)
-    print("Metadata:", metadata)
-
-# Include the router
-app.include_router(
-    create_api_router(
-        files_dir="/tmp/uploads",        # OPTIONAL: directory to store files
-        max_size=128_849_018_880,         # OPTIONAL: max upload size in bytes (~120GB)
-        on_upload_complete=on_upload_complete,  # OPTIONAL: callback when upload finishes
-        prefix="files",                 # OPTIONAL: URL prefix (default: 'files')
-    ),
-)
-
-```
-
-### !Warning If you include your own router then it is necessary that your app allows these Headers:
-
-```python
-app.add_middleware( 
-   CORSMiddleware, (# OPTIONAL: add CORS middleware if needed)
-   allow_origins=["*"], # OPTIONAL: allow all origins
-   allow_methods=["*"], # OPTIONAL: allow all methods
-   allow_headers=["*"], # OPTIONAL: allow all headers
-   expose_headers=[ # REQUIRED: expose these headers to the client
-    "Location",
-    "Upload-Offset",
-    "Tus-Resumable",
-    "Tus-Version",
-    "Tus-Extension",
-    "Tus-Max-Size",
-    "Upload-Expires",
-   ],
-)
-```
-
-### Dependency‑Injected Hook (Advanced)
-
-For applications using FastAPI's dependency injection, you can supply a factory that returns a DI‑enabled callback. This factory can `Depends()` on any of your services (database session, current user, etc.).
-
-```python
-# Define a factory dependency that injects your own services
-from fastapi import Depends
-from your_app.dependencies import get_db, get_current_user
-
-def get_upload_handler(
-    db=Depends(get_db),
-    current_user=Depends(get_current_user),
-) -> Callable[[str, dict], None]:
-    def handler(file_path: str, metadata: dict):
-        # perform validation or post-processing
-        db.log_upload(current_user.id, metadata)
-        process_file(file_path)
-    return handler
-
-# Include router with the DI hook
-app.include_router(
-    create_api_router(
-        on_upload_complete=None,            # keep default
-        upload_complete_dep=get_upload_handler,  # factory dependency
-    )
-)
-```
-
-### Features
-
-* **Resumable uploads** via TUS protocol
-* **Chunked transfer** with configurable max size
-* **Metadata storage** (filename, filetype)
-* **Expiration & cleanup** of old uploads (default retention: 5 days)
-* **Download**, **HEAD**, **DELETE**, and **OPTIONS** endpoints
-* **Optional** DI‑friendly `upload_complete_dep` for seamless integration with FastAPI
-
-## Scheduler (Cleanup)
-
-Expired files are removed when `remove_expired_files()` is called. You can schedule it using your preferred background scheduler (e.g., `APScheduler`, `cron`).
-
-```python
-from apscheduler.schedulers.background import BackgroundScheduler
-
-scheduler = BackgroundScheduler()
-scheduler.add_job(
-    lambda: router.remove_expired_files(),
-    trigger='cron',
-    hour=1,
-)
-scheduler.start()
-```
-
-## Versioning & Publishing
-
-**Before releasing:**
-
-1. Update the version in `setup.py`:
-
-   * **Patch** for bug fixes
-   * **Minor** for new features
-   * **Major** for breaking changes
-2. Commit and push to `main`.
-3. Open a PR to merge `main` → `production`.
-4. Upon merge, CI/CD will publish to PyPI.
-
-## Contributing
-
-Contributions welcome! Please open issues or PRs on [GitHub](https://github.com/edihasaj/tuspy-fast-api).
-
-*© 2025 Edi Hasaj [X](https://x.com/hasajedi)*

tuspyserver-2.2.2/tuspyserver.egg-info/SOURCES.txt

@@ -1,11 +0,0 @@
-LICENSE
-README.md
-setup.py
-tuspyserver.egg-info/PKG-INFO
-tuspyserver.egg-info/SOURCES.txt
-tuspyserver.egg-info/dependency_links.txt
-tuspyserver.egg-info/requires.txt
-tuspyserver.egg-info/top_level.txt
-tusserver/__init__.py
-tusserver/metadata.py
-tusserver/tus.py

tuspyserver-2.2.2/tuspyserver.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

tuspyserver-2.2.2/tuspyserver.egg-info/requires.txt

@@ -1,2 +0,0 @@
-fastapi>=0.110.0
-pydantic>=2.6.2

tuspyserver-2.2.2/tuspyserver.egg-info/top_level.txt

@@ -1 +0,0 @@
-tusserver

tuspyserver-2.2.2/tusserver/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.0.0"