15ea23d5d6
* feat: introduce hindsight-api-slim and hindsight-all-slim packages Closes #552 - Move all source code from hindsight-api/ to new hindsight-api-slim/ - hindsight-api-slim has heavy ML deps (torch, sentence-transformers, transformers, einops, flashrank, mlx, mlx-lm, safetensors) and pg0-embedded as optional extras: [local-ml], [embedded-db], [all] - hindsight-api becomes a zero-code meta-package depending on hindsight-api-slim[all] for full backward compatibility - Add hindsight-all-slim meta-package: hindsight-api-slim + client + embed - hindsight-all updated to depend on hindsight-api-slim[all] - pg0.py: lazy-import pg0 with clear ImportError pointing to [embedded-db] - Dockerfile: replace sed hack with proper uv sync --extra flags - Update release.yml, test.yml, lint.sh, release.sh, CLAUDE.md and all path references throughout the repo * refactor: rename hindsight/ directory to hindsight-all/ * docs: document hindsight-api-slim and hindsight-all-slim package variants Add package variants table and extras explanation to installation.md * docs: remove emojis from installation.md, use professional tone * docs: link Docker slim variant to pip package variants section * docs: consolidate Docker image variants into single table * ci: fix working-directory paths after package restructure - Replace all hindsight-api → hindsight-api-slim in test.yml - Replace hindsight → hindsight-all in test.yml - Add --extra embedded-db to test-embed API install step * ci: add local-ml and embedded-db extras to API sync steps These extras were previously implicit in the old hindsight-api package (which bundled everything). Now that hindsight-api-slim uses optional extras, we must explicitly request local-ml and embedded-db in CI. * ci: add API install step with embedded-db to test-embed smoke test The smoke test starts hindsight-api as a daemon, which requires pg0-embedded. Add a dedicated install step for hindsight-api-slim with embedded-db extra so the daemon can start successfully. * ci: remove --no-install-project when using optional extras When --no-install-project is combined with --extra, the optional deps are not installed because extras require the project to be active. Remove --no-install-project from steps that need local-ml or embedded-db. * ci: fix ordering of uv sync steps to preserve optional extras When uv sync runs for a different workspace member, it removes optional extras installed for other members. Fix by always running extra-requiring API sync last, after other workspace member syncs. Also remove --no-install-project from embedded-db sync in test-embed, as --no-install-project prevents optional extras from being active. * ci: add local-ml extra to test-embed API install for smoke test The smoke test starts the full API server which needs sentence-transformers for local embeddings (default provider). Add local-ml extra to the install. * ci: simplify extras with --all-extras and add slim pip smoke test - Replace explicit --extra local-ml --extra embedded-db with --all-extras for cleaner, more maintainable sync steps - Add test-pip-slim job: tests hindsight-api-slim[embedded-db] without local ML models, using Cohere for embeddings/reranking (mirrors Docker slim smoke test approach) * ci: simplify slim smoke test to health check only (mirrors Docker test)
83 lines
1.8 KiB
Python
83 lines
1.8 KiB
Python
"""Abstract base class for file storage backends."""
|
|
|
|
from abc import ABC, abstractmethod
|
|
|
|
|
|
class FileStorage(ABC):
|
|
"""Abstract base for file storage backends."""
|
|
|
|
@abstractmethod
|
|
async def store(
|
|
self,
|
|
file_data: bytes,
|
|
key: str,
|
|
metadata: dict[str, str] | None = None,
|
|
) -> str:
|
|
"""
|
|
Store file and return storage key.
|
|
|
|
Args:
|
|
file_data: Raw file bytes
|
|
key: Storage key (e.g., "banks/{bank_id}/files/{file_id}.pdf")
|
|
metadata: Optional metadata to store with file
|
|
|
|
Returns:
|
|
Storage key that can be used to retrieve the file
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def retrieve(self, key: str) -> bytes:
|
|
"""
|
|
Retrieve file by storage key.
|
|
|
|
Args:
|
|
key: Storage key
|
|
|
|
Returns:
|
|
File data as bytes
|
|
|
|
Raises:
|
|
FileNotFoundError: If file does not exist
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def delete(self, key: str) -> None:
|
|
"""
|
|
Delete file by storage key.
|
|
|
|
Args:
|
|
key: Storage key
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def exists(self, key: str) -> bool:
|
|
"""
|
|
Check if file exists.
|
|
|
|
Args:
|
|
key: Storage key
|
|
|
|
Returns:
|
|
True if file exists, False otherwise
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def get_download_url(self, key: str, expires_in: int = 3600) -> str:
|
|
"""
|
|
Get a URL for downloading the file.
|
|
|
|
For PostgreSQL storage, this might be a relative API path.
|
|
For S3, this would be a pre-signed URL.
|
|
|
|
Args:
|
|
key: Storage key
|
|
expires_in: Expiration time in seconds (may be ignored for some backends)
|
|
|
|
Returns:
|
|
Download URL or path
|
|
"""
|
|
pass
|