chewy-attachment 0.1.0__py3-none-any.whl

chewy_attachment-0.1.0.dist-info/METADATA

@@ -0,0 +1,384 @@
+Metadata-Version: 2.4
+Name: chewy-attachment
+Version: 0.1.0
+Summary: 通用图片/附件管理插件，支持 Django 和 FastAPI
+Project-URL: Homepage, https://github.com/cone387/ChewyAttachment
+Project-URL: Repository, https://github.com/cone387/ChewyAttachment
+Project-URL: Issues, https://github.com/cone387/ChewyAttachment/issues
+Project-URL: Documentation, https://github.com/cone387/ChewyAttachment#readme
+Author-email: cone387 <cone387@gmail.com>
+Maintainer-email: cone387 <cone387@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: attachment,django,fastapi,file-management,file-upload,image-upload
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: python-magic>=0.4.27
+Provides-Extra: dev
+Requires-Dist: django>=5.0.0; extra == 'dev'
+Requires-Dist: djangorestframework>=3.14.0; extra == 'dev'
+Requires-Dist: fastapi>=0.109.0; extra == 'dev'
+Requires-Dist: httpx>=0.26.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-django>=4.7.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: python-multipart>=0.0.6; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: sqlmodel>=0.0.14; extra == 'dev'
+Requires-Dist: uvicorn>=0.27.0; extra == 'dev'
+Provides-Extra: django
+Requires-Dist: django>=5.0.0; extra == 'django'
+Requires-Dist: djangorestframework>=3.14.0; extra == 'django'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.109.0; extra == 'fastapi'
+Requires-Dist: python-multipart>=0.0.6; extra == 'fastapi'
+Requires-Dist: sqlmodel>=0.0.14; extra == 'fastapi'
+Requires-Dist: uvicorn>=0.27.0; extra == 'fastapi'
+Provides-Extra: test
+Requires-Dist: httpx>=0.26.0; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest>=8.0.0; extra == 'test'
+Provides-Extra: test-django
+Requires-Dist: django>=5.0.0; extra == 'test-django'
+Requires-Dist: djangorestframework>=3.14.0; extra == 'test-django'
+Requires-Dist: httpx>=0.26.0; extra == 'test-django'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test-django'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test-django'
+Requires-Dist: pytest-django>=4.7.0; extra == 'test-django'
+Requires-Dist: pytest>=8.0.0; extra == 'test-django'
+Provides-Extra: test-fastapi
+Requires-Dist: fastapi>=0.109.0; extra == 'test-fastapi'
+Requires-Dist: httpx>=0.26.0; extra == 'test-fastapi'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test-fastapi'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test-fastapi'
+Requires-Dist: pytest>=8.0.0; extra == 'test-fastapi'
+Requires-Dist: python-multipart>=0.0.6; extra == 'test-fastapi'
+Requires-Dist: sqlmodel>=0.0.14; extra == 'test-fastapi'
+Requires-Dist: uvicorn>=0.27.0; extra == 'test-fastapi'
+Description-Content-Type: text/markdown
+
+# ChewyAttachment
+
+🚀 通用文件/附件管理服务 - 支持 Django & FastAPI 双框架
+
+## 📖 简介
+
+ChewyAttachment 是一个通用的文件/附件管理插件，提供开箱即用的文件上传、下载、删除功能。支持作为独立的 Django 应用或 FastAPI 可插拔模块运行，适合个人自托管场景，可被多个业务系统复用。
+
+## ✨ 核心特性
+
+- 🔄 **双框架支持**: 同时支持 Django 和 FastAPI
+- 📁 **完整功能**: 文件上传、下载、删除、列表查询
+- 🔐 **简化权限**: 基于 owner_id 的权限模型，支持 public/private 访问级别
+- 🎯 **认证解耦**: 通过外部注入 user_id 实现认证解耦
+- 📝 **Markdown 友好**: 返回 Markdown 格式的文件引用链接
+- 🗄️ **轻量存储**: SQLite + 本地文件系统，数据库仅存元信息
+- 🔌 **即插即用**: 独立于具体业务表的通用数据模型
+- 🎨 **RESTful API**: 标准化的 API 设计
+
+## 📦 安装
+
+```bash
+# 使用 pip 安装
+pip install chewy-attachment
+
+# 或从源码安装
+git clone https://github.com/cone387/ChewyAttachment.git
+cd ChewyAttachment
+pip install -e .
+```
+
+## 🚀 快速开始
+
+### Django 集成
+
+1. **添加到 INSTALLED_APPS**
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    'chewy_attachment.django_app',
+]
+
+# 配置文件存储
+MEDIA_URL = '/media/'
+MEDIA_ROOT = BASE_DIR / 'media'
+```
+
+2. **配置 URL**
+
+```python
+# urls.py
+from django.urls import path, include
+from django.conf import settings
+from django.conf.urls.static import static
+
+urlpatterns = [
+    # ...
+    path('api/attachments/', include('chewy_attachment.django_app.urls')),
+] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+```
+
+3. **运行迁移**
+
+```bash
+python manage.py migrate
+```
+
+### FastAPI 集成
+
+```python
+from fastapi import FastAPI, Depends
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker, Session
+from chewy_attachment.fastapi_app.router import router as attachment_router
+from chewy_attachment.fastapi_app.models import Base
+from chewy_attachment.fastapi_app.dependencies import get_current_user_id
+
+app = FastAPI()
+
+# 数据库配置
+engine = create_engine("sqlite:///./attachments.db")
+SessionLocal = sessionmaker(bind=engine)
+Base.metadata.create_all(bind=engine)
+
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+# 自定义用户认证
+async def custom_get_user_id() -> int:
+    # 实现你的用户认证逻辑
+    return 1  # 示例
+
+# 挂载路由
+app.include_router(
+    attachment_router,
+    prefix="/api/attachments",
+    dependencies=[Depends(get_db)]
+)
+
+# 覆盖默认的用户认证依赖
+app.dependency_overrides[get_current_user_id] = custom_get_user_id
+```
+
+## 📚 API 文档
+
+### 上传文件
+
+```bash
+POST /api/attachments/
+Content-Type: multipart/form-data
+
+参数:
+- file: 文件对象
+- is_public: boolean (可选，默认 true)
+- description: string (可选)
+```
+
+### 获取文件列表
+
+```bash
+GET /api/attachments/
+
+查询参数:
+- owner_id: int (可选)
+- is_public: boolean (可选)
+- skip: int (可选，分页偏移)
+- limit: int (可选，每页数量)
+```
+
+### 获取文件详情
+
+```bash
+GET /api/attachments/{attachment_id}/
+```
+
+### 下载文件
+
+```bash
+GET /api/attachments/{attachment_id}/download/
+```
+
+### 删除文件
+
+```bash
+DELETE /api/attachments/{attachment_id}/
+```
+
+## 🔐 权限模型
+
+- **Public 文件**: 所有人可读，仅所有者可删除
+- **Private 文件**: 仅所有者可读可删除
+- **Owner ID**: 通过外部认证系统注入，实现认证解耦
+
+## 📁 数据模型
+
+```python
+class Attachment:
+    id: int
+    filename: str          # 原始文件名
+    file_path: str         # 物理存储路径
+    file_size: int         # 文件大小(字节)
+    content_type: str      # MIME 类型
+    owner_id: int          # 所有者 ID
+    is_public: bool        # 访问级别
+    description: str       # 描述信息
+    created_at: datetime   # 创建时间
+    updated_at: datetime   # 更新时间
+```
+
+## 🛠️ 配置选项
+
+### Django 配置
+
+```python
+# settings.py
+
+# 文件存储路径
+MEDIA_ROOT = BASE_DIR / 'media'
+MEDIA_URL = '/media/'
+
+# 最大上传大小 (可选)
+DATA_UPLOAD_MAX_MEMORY_SIZE = 10 * 1024 * 1024  # 10MB
+
+# 自定义权限类 (可选)
+# 如果不配置,则使用默认权限类
+ATTACHMENTS_PERMISSION_CLASSES = [
+    "chewy_attachment.django_app.permissions.IsAuthenticatedForUpload",
+    "chewy_attachment.django_app.permissions.IsOwnerOrPublicReadOnly",
+    # 或使用你的自定义权限类:
+    # "myapp.permissions.CustomAttachmentPermission",
+]
+```
+
+#### 自定义权限类示例
+
+```python
+# myapp/permissions.py
+from rest_framework import permissions
+from chewy_attachment.django_app.models import Attachment
+from chewy_attachment.core.permissions import PermissionChecker
+
+class CustomAttachmentPermission(permissions.BasePermission):
+    """
+    自定义附件权限类
+    
+    示例: 管理员可以访问所有文件,普通用户只能访问自己的文件
+    """
+    
+    def has_object_permission(self, request, view, obj: Attachment):
+        # 管理员拥有所有权限
+        if request.user and request.user.is_staff:
+            return True
+        
+        # 使用核心权限检查器
+        user_context = Attachment.get_user_context(request)
+        file_metadata = obj.to_file_metadata()
+        
+        if request.method in permissions.SAFE_METHODS:
+            return PermissionChecker.can_view(file_metadata, user_context)
+        
+        if request.method == "DELETE":
+            return PermissionChecker.can_delete(file_metadata, user_context)
+        
+        return False
+
+# settings.py
+ATTACHMENTS_PERMISSION_CLASSES = [
+    "chewy_attachment.django_app.permissions.IsAuthenticatedForUpload",
+    "myapp.permissions.CustomAttachmentPermission",
+]
+```
+
+### FastAPI 配置
+
+```python
+# 自定义存储路径
+from chewy_attachment.core.storage import FileStorage
+
+storage = FileStorage(base_path="/custom/path/media")
+```
+
+## 📂 项目结构
+
+```
+ChewyAttachment/
+├── chewy_attachment/
+│   ├── core/                 # 核心功能模块
+│   │   ├── schemas.py        # 数据模式
+│   │   ├── storage.py        # 文件存储
+│   │   ├── permissions.py    # 权限控制
+│   │   └── utils.py          # 工具函数
+│   ├── django_app/           # Django 应用
+│   │   ├── models.py         # Django 模型
+│   │   ├── views.py          # Django 视图
+│   │   ├── serializers.py    # DRF 序列化器
+│   │   └── urls.py           # URL 配置
+│   └── fastapi_app/          # FastAPI 应用
+│       ├── models.py         # SQLAlchemy 模型
+│       ├── router.py         # API 路由
+│       ├── crud.py           # CRUD 操作
+│       └── dependencies.py   # 依赖注入
+├── examples/                 # 示例项目
+│   ├── django_example/       # Django 示例
+│   └── fastapi_example/      # FastAPI 示例
+└── pyproject.toml            # 项目配置
+```
+
+## 🧪 运行测试
+
+```bash
+# 安装测试依赖
+pip install pytest pytest-django pytest-asyncio
+
+# 运行 Django 测试
+pytest chewy_attachment/django_app/tests/
+
+# 运行 FastAPI 测试
+pytest chewy_attachment/fastapi_app/tests/
+```
+
+## 📝 示例代码
+
+查看 `examples/` 目录获取完整的示例项目：
+
+- [Django 示例](examples/django_example/)
+- [FastAPI 示例](examples/fastapi_example/)
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📄 License
+
+MIT License
+
+## 👤 作者
+
+- GitHub: [@cone387](https://github.com/cone387)
+
+## 🔗 相关链接
+
+- [项目主页](https://github.com/cone387/ChewyAttachment)
+- [问题反馈](https://github.com/cone387/ChewyAttachment/issues)

chewy_attachment-0.1.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+chewy_attachment/__init__.py,sha256=7L5DeDKEGk3E1MimJPwOc1229oiD96jgxxw7SYNEF3I,79
+chewy_attachment/core/__init__.py,sha256=U65Ugixq32koHoVTKt4qPY7Gknwz7aOGapea8KqJRWI,503
+chewy_attachment/core/exceptions.py,sha256=c3gZvle7HVrm70lJaXcgiFVnwwrDyB8yfQNcPdL-LGM,1040
+chewy_attachment/core/permissions.py,sha256=7Us-SXMrx4NC8pqTUTJVATGQnghG38i8tFvWlq3x-qY,3625
+chewy_attachment/core/schemas.py,sha256=bwE5IpX-AFTQVTSYpYP6sGtOChJvSy3tlV5Tt08HRz8,1531
+chewy_attachment/core/storage.py,sha256=GYl0n1oKCVFJwId7BlLI8eXCahTPSxjyF3YROXx-uJA,4764
+chewy_attachment/core/utils.py,sha256=HtyIigHlth_XcPZc9jCQd0OaXB3nsdAn5fYXks-_RFw,1339
+chewy_attachment/django_app/__init__.py,sha256=f-RS9E-YhPg-FRYmy8lFpEehdo-8Yper1tf5vViQQtA,126
+chewy_attachment/django_app/admin.py,sha256=81tucyumBrXLbnFm9pLFQlDKZ9SI0Z2AY5zURnay93g,565
+chewy_attachment/django_app/apps.py,sha256=U35mYn0d2oIo4Bg59eMlIsMwsOkppqPemMagYes_-ug,300
+chewy_attachment/django_app/models.py,sha256=3xu4gv5pTkxf-diIHQBO5ibE9wRjMqKJ2jf3uGFHP6w,2134
+chewy_attachment/django_app/permissions.py,sha256=fkBIbDvZBeLLhVdCtY_UG-uofc7R6cV9_e9CPFGxs9w,1100
+chewy_attachment/django_app/serializers.py,sha256=fLeKYnOH0z2W1Cx-BH7qAzzKuHbPj7IBsoXFaqBsUMU,908
+chewy_attachment/django_app/urls.py,sha256=bBSc17KZRBg-AYB79oscGSbKl_COa8I9mrK2SMc9PQE,331
+chewy_attachment/django_app/views.py,sha256=IuntK-Gzui0T0gZPdqre3wHk839XFboCbw1aMBmCrno,6856
+chewy_attachment/django_app/migrations/0001_initial.py,sha256=kffjcDwKW8NTCiPmfIam8kYdxnWFdT_6SThBQ3gctm4,1196
+chewy_attachment/django_app/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chewy_attachment/django_app/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chewy_attachment/django_app/tests/conftest.py,sha256=7oNZipszSvcjQWbNV1dX7f8EpH_wiF5t4uzmV5Lehrs,1489
+chewy_attachment/django_app/tests/test_views.py,sha256=5oZPJAtDTjpFhZcF0NcEuBPVFtBeuLWeS-5VfLh9zHA,7605
+chewy_attachment/fastapi_app/__init__.py,sha256=ZoqZPpuJXmm2yu_pEluX3_7pWGyCQg4-B06JW_d2U7Y,98
+chewy_attachment/fastapi_app/crud.py,sha256=vU63MIv0YSuPz3s2wwWFZposy2uvq1TvmbDMy9otfeo,2183
+chewy_attachment/fastapi_app/dependencies.py,sha256=0iPrqtza71mhvADXC6XZk4wQEtOUkLxHKTQfUBawh8A,4752
+chewy_attachment/fastapi_app/models.py,sha256=hqkUEUeELFR6nL1PBLp66An9OLKKMgUWz8TZfSMW7r4,1440
+chewy_attachment/fastapi_app/router.py,sha256=HTvwH5OPoGf-MsDTOcth5tUVxLCYTgsII63l_CBFrjg,3728
+chewy_attachment/fastapi_app/schemas.py,sha256=9cyDtqobYsQ6oP3xkFTmLbqL--V_d_5m6Ao2UXezQG0,589
+chewy_attachment/fastapi_app/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chewy_attachment/fastapi_app/tests/conftest.py,sha256=QywBR0TpruoyVK6m1phx-jndn1nUEjfbnljHoWSl5LI,2572
+chewy_attachment/fastapi_app/tests/test_router.py,sha256=8rydAXBCaYny9bKY9FH1CqsBQsteACVDPB-1JKPlWfk,6739
+chewy_attachment-0.1.0.dist-info/METADATA,sha256=yATQm-gccUQw4Kw2O6LfYbKgujAmBzoRu9T36HPSCA4,11416
+chewy_attachment-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+chewy_attachment-0.1.0.dist-info/licenses/LICENSE,sha256=TMqmDHaLuyiLHBCVMyV-tCAQlzdhhmTXRB-lP-KLGtk,1064
+chewy_attachment-0.1.0.dist-info/RECORD,,

chewy_attachment-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

chewy_attachment-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cone387
+
+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.