fastapi-authly 0.1.2__tar.gz → 0.1.4__tar.gz

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-authly
-Version: 0.1.2
+Version: 0.1.4
 Summary: A modular authentication system for FastAPI with OAuth2, JWT, and password recovery
 Project-URL: Homepage, https://github.com/yourusername/fastapi-auth-module
 Project-URL: Documentation, https://yourusername.github.io/fastapi-auth-module/
@@ -25,6 +25,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP :: Session
 Classifier: Topic :: Security
 Requires-Python: >=3.10
+Requires-Dist: asyncpg>=0.31.0
 Requires-Dist: emails>=0.6.0
 Requires-Dist: fastapi>=0.100.0
 Requires-Dist: jinja2>=3.0.0
@@ -35,6 +36,7 @@ Requires-Dist: pydantic[email]>=2.0.0
 Requires-Dist: python-jose[cryptography]>=3.3.0
 Requires-Dist: python-multipart>=0.0.6
 Requires-Dist: tortoise-orm[psycopg]>=0.25.3
+Requires-Dist: uvicorn>=0.40.0
 Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
 Requires-Dist: mkdocs>=1.5.0; extra == 'docs'

fastapi_authly-0.1.4/examples/correct_usage.py

@@ -0,0 +1,74 @@
+"""
+正确的使用方式示例
+"""
+
+from fastapi import FastAPI
+from tortoise.contrib.fastapi import register_tortoise
+from fastapi_authly import (
+    AuthConfig, 
+    AuthDependencyConfig, 
+    create_auth_router,
+    JwtConfig,
+    setup_scalar_docs
+)
+from fastapi_authly.contrib.tortoise_pg import TortoiseUserRepository
+
+app = FastAPI(title="FastAPI Authly 测试应用")
+
+# 初始化 Tortoise + Postgres
+register_tortoise(
+    app,
+    db_url="postgres://user:password@localhost:5432/testdb",
+    modules={"models": ["fastapi_authly.models.user"]},
+    generate_schemas=True,
+    add_exception_handlers=True,
+)
+
+# 方式 1: 使用 JwtConfig 实例（推荐）
+config = AuthConfig(
+    jwt=JwtConfig(
+        secret_key="your-secret-key-change-in-production",
+        algorithm="HS256",
+        access_token_expires_minutes=30,
+        refresh_token_expire_days=7,
+    ),
+    router_prefix="/auth",
+    token_url="login",
+)
+
+# 方式 2: 使用字典更新（也可以）
+# config = AuthConfig(
+#     jwt={
+#         "secret_key": "your-secret-key-change-in-production",
+#         "algorithm": "HS256",
+#         "access_token_expires_minutes": 30,
+#     },
+#     router_prefix="/auth",
+#     token_url="login",
+# )
+
+# 方式 3: 使用默认配置，然后通过环境变量覆盖
+# 设置环境变量: AUTH_JWT__SECRET_KEY=your-secret-key
+# config = AuthConfig(
+#     router_prefix="/auth",
+#     token_url="login",
+# )
+
+deps = AuthDependencyConfig(
+    user_repository=TortoiseUserRepository(),
+)
+
+# 注册认证路由
+auth_router = create_auth_router(config=config, dependencies=deps)
+app.include_router(auth_router)
+
+# 设置 Scalar 文档
+setup_scalar_docs(app, docs_url="/docs", static_url="/static")
+
+@app.get("/")
+async def root():
+    return {"message": "FastAPI Authly 测试应用已启动"}
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8000)

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi-authly"
-version = "0.1.2"
+version = "0.1.4"
 description = "A modular authentication system for FastAPI with OAuth2, JWT, and password recovery"
 readme = "README.md"
 license = {text = "MIT"}
@@ -49,6 +49,8 @@ dependencies = [
     "jinja2>=3.0.0",
     "jwt>=1.3.1",
     "tortoise-orm[psycopg]>=0.25.3",
+    "uvicorn>=0.40.0",
+    "asyncpg>=0.31.0",
 ]
 
 [project.optional-dependencies]

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/__about__.py

@@ -1,3 +1,3 @@
 """Version information."""
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/__init__.py

@@ -7,21 +7,23 @@ This package provides a complete authentication solution with:
 - Password recovery
 - User management
 - Modular and configurable design
+- Built-in Scalar API documentation
 """
 
 from .auth import AuthModule, create_auth_router
-from .core import AuthConfig, AuthDependencyConfig, BcryptPasswordHasher, JWTTokenService
+from .core import AuthConfig, AuthDependencyConfig, JwtConfig, BcryptPasswordHasher, JWTTokenService
 from .docs import setup_scalar_docs
 from .interfaces import Mailer, PasswordHasher, TokenService, UserRepository
 from .schemas.user import UserBase, UserCreate, UserUpdate, UserPublic, Token, TokenData
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 __all__ = [
     # Main classes
     "AuthModule",
     "AuthConfig",
     "AuthDependencyConfig",
+    "JwtConfig",
 
     # Core functions
     "create_auth_router",

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/auth.py

@@ -103,12 +103,14 @@ class AuthModule:
                     status_code=status.HTTP_400_BAD_REQUEST,
                     detail="Incorrect username or password",
                 )
-            if not self.password_hasher.verify(body.password, getattr(user, "hashed_password", "")):
+
+            hashed_password = getattr(user, "hashed_password", None) or ""
+            if not hashed_password or not self.password_hasher.verify(body.password, hashed_password):
                 raise HTTPException(
                     status_code=status.HTTP_400_BAD_REQUEST,
                     detail="Incorrect username or password",
                 )
-
+                
             if not user.is_active:
                 raise HTTPException(status_code=400, detail="Inactive user")
 

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/core/__init__.py

@@ -1,11 +1,12 @@
 """Core functionality for fastapi-authly."""
 
-from .config import AuthConfig, AuthDependencyConfig
+from .config import AuthConfig, AuthDependencyConfig, JwtConfig
 from .security import BcryptPasswordHasher, JWTTokenService
 
 __all__ = [
     "AuthConfig",
     "AuthDependencyConfig",
+    "JwtConfig",
     "BcryptPasswordHasher",
     "JWTTokenService",
 ]

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/core/config.py

@@ -1,8 +1,8 @@
 """Configuration settings for fastapi-authly."""
 
-from typing import List, Optional, Any
+from typing import List, Optional, Any, Union
 from datetime import timedelta
-from pydantic import BaseModel, Field, ConfigDict
+from pydantic import BaseModel, Field, ConfigDict, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 class JwtConfig(BaseModel):
@@ -26,8 +26,6 @@ class JwtConfig(BaseModel):
         return timedelta(days=self.refresh_token_expires_days)
 
 
-
-
 class AuthConfig(BaseSettings):
     """
     Runtime configuration loaded from environment variables with ``AUTH_`` prefix.
@@ -35,10 +33,11 @@ class AuthConfig(BaseSettings):
     Host applications can still pass an ``AuthConfig`` instance directly;
     in that case, the passed values override the environment values.
     """
-    jwt: JwtConfig = JwtConfig()
+    jwt: Union[JwtConfig, dict] = Field(default_factory=JwtConfig)
 
     router_prefix: str = "/auth"
     router_tags: List[str] = Field(default_factory=lambda: ["authentication"])
+    token_url: str = "login"  # OAuth2 token URL path
 
     enable_password_recovery: bool = True
     enable_user_registration: bool = True
@@ -58,6 +57,48 @@ class AuthConfig(BaseSettings):
         env_prefix="AUTH_",
         extra="ignore",
     )
+    
+    @model_validator(mode='after')
+    def _ensure_jwt_is_config(self):
+        """确保 jwt 字段始终是 JwtConfig 实例"""
+        if isinstance(self.jwt, dict):
+            self.jwt = JwtConfig(**self.jwt)
+        elif not isinstance(self.jwt, JwtConfig):
+            self.jwt = JwtConfig()
+        return self
+    
+    def _ensure_jwt_config(self) -> JwtConfig:
+        """确保 jwt 是 JwtConfig 实例，如果不是则转换"""
+        if isinstance(self.jwt, dict):
+            self.jwt = JwtConfig(**self.jwt)
+        elif not isinstance(self.jwt, JwtConfig):
+            self.jwt = JwtConfig()
+        return self.jwt
+    
+    # 属性访问器：直接访问 jwt 中的属性，兼容现有代码
+    @property
+    def secret_key(self) -> str:
+        """JWT secret key"""
+        jwt_config = self._ensure_jwt_config()
+        return jwt_config.secret_key
+    
+    @property
+    def algorithm(self) -> str:
+        """JWT algorithm"""
+        jwt_config = self._ensure_jwt_config()
+        return jwt_config.algorithm
+    
+    @property
+    def access_token_expire_minutes(self) -> Optional[int]:
+        """Access token expiration in minutes (compatible with auth.py)"""
+        jwt_config = self._ensure_jwt_config()
+        return jwt_config.access_token_expires_minutes
+    
+    @property
+    def refresh_token_expire_days(self) -> int:
+        """Refresh token expiration in days"""
+        jwt_config = self._ensure_jwt_config()
+        return jwt_config.refresh_token_expires_days
 
 _config = AuthConfig()
 
@@ -74,4 +115,6 @@ class AuthDependencyConfig(BaseModel):
     token_service: Optional[Any] = None
     mailer: Optional[Any] = None
     # 可选：自定义 token 提取依赖（例如自定义 Bearer/JWT 解析）
+    # token_dependency: Optional[Any] = Noneptional[Any] = None
+    # 可选：自定义 token 提取依赖（例如自定义 Bearer/JWT 解析）
     token_dependency: Optional[Any] = None

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/core/security.py

@@ -3,6 +3,7 @@ from typing import Any, Dict, Optional
 
 from jose import JWTError, jwt
 from passlib.context import CryptContext
+from passlib.exc import UnknownHashError
 
 from ..interfaces import PasswordHasher, TokenService
 
@@ -18,7 +19,13 @@ class BcryptPasswordHasher(PasswordHasher):
         return self._ctx.hash(password)
 
     def verify(self, password: str, hashed: str) -> bool:
-        return self._ctx.verify(password, hashed)
+        if not hashed:
+            return False
+        try:
+            return self._ctx.verify(password, hashed)
+        except UnknownHashError:
+            # 如果哈希格式无法识别，返回 False
+            return False
 
 
 class JWTTokenService(TokenService):

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/src/fastapi_authly/docs.py

@@ -21,6 +21,7 @@ def setup_scalar_docs(
     static_url: str = "/static",
     title: Optional[str] = None,
     openapi_url: Optional[str] = None,
+    favicon_url: Optional[str] = None,
 ) -> None:
     """
     为 FastAPI 应用设置 Scalar API 文档
@@ -31,6 +32,8 @@ def setup_scalar_docs(
         static_url: 静态文件 URL 前缀，默认为 "/static"
         title: 文档标题，默认使用 app.title
         openapi_url: OpenAPI schema URL，默认使用 app.openapi_url
+        favicon_url: Favicon 图标 URL，默认为 "{static_url}/favicon.svg"
+                    如果设置为 None，将尝试使用默认路径
     """
     static_dir = get_static_dir()
     
@@ -42,6 +45,22 @@ def setup_scalar_docs(
     doc_title = title or app.title
     api_url = openapi_url or app.openapi_url
     
+    if favicon_url is None:
+        static_dir = get_static_dir()
+        # 优先尝试 SVG，然后是 ICO
+        if os.path.exists(static_dir / "favicon.svg"):
+            favicon_url = f"{static_url}/favicon.svg"
+        else:
+            favicon_url = f"{static_url}/favicon.ico"
+    
+    favicon_type = "image/x-icon"  # 默认 ICO
+    if favicon_url.lower().endswith(".svg"):
+        favicon_type = "image/svg+xml"
+    elif favicon_url.lower().endswith(".png"):
+        favicon_type = "image/png"
+    elif favicon_url.lower().endswith(".ico"):
+        favicon_type = "image/x-icon"
+    
     # 创建文档路由
     @app.get(docs_url, include_in_schema=False)
     async def scalar_html():
@@ -52,6 +71,7 @@ def setup_scalar_docs(
             <title>{doc_title}</title>
             <meta charset="utf-8"/>
             <meta name="viewport" content="width=device-width, initial-scale=1"/>
+            <link rel="icon" type="{favicon_type}" href="{favicon_url}">
             <link rel="stylesheet" href="{static_url}/scalar/style.css">
         </head>
         <body>

fastapi_authly-0.1.4/src/fastapi_authly/static/favicon.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1769412556021" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5147" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M24.856135 296.081347L490.69745 507.422478a51.196979 51.196979 0 0 0 42.595887 0l465.841316-211.341131c33.073249-15.000715 33.073249-65.020164 0-80.020879L533.293337 4.668141a51.196979 51.196979 0 0 0-42.595887 0l-465.892512 211.289933c-33.073249 15.051912-33.073249 65.020164 0 80.072076z m974.278518 176.578382l-116.217144-52.681692-323.20653 146.525755a114.732431 114.732431 0 0 1-95.43117 0L141.022081 419.978037 24.804938 472.659729c-33.073249 15.000715-33.073249 65.020164 0 79.969682l465.892512 211.18754c13.618397 6.143638 28.97749 6.143638 42.595887 0l465.841316-211.18754c33.073249-15.000715 33.073249-65.020164 0-79.969682z m0 255.575321l-115.705174-52.476904-323.7185 146.730543a114.732431 114.732431 0 0 1-95.43117 0l-323.667304-146.730543-115.75637 52.476904c-33.124446 15.000715-33.124446 65.020164 0 79.969682l465.841315 211.18754c13.618397 6.143638 28.97749 6.143638 42.595887 0l465.841316-211.18754c33.073249-15.000715 33.073249-65.020164 0-79.969682z" fill="#03CDC1" p-id="5148"></path></svg>

fastapi_authly-0.1.4/test.py

@@ -0,0 +1,73 @@
+"""
+正确的使用方式示例
+"""
+
+from fastapi import FastAPI
+from tortoise.contrib.fastapi import register_tortoise
+from src.fastapi_authly import (
+    AuthConfig,
+    AuthDependencyConfig,
+    create_auth_router,
+    JwtConfig,
+    setup_scalar_docs
+)
+from src.fastapi_authly.contrib.tortoise_pg import TortoiseUserRepository
+
+app = FastAPI(title="FastAPI Authly 测试应用", docs_url="/old_docs",)
+
+# 初始化 Tortoise + Postgres
+register_tortoise(
+    app,
+    db_url="postgres://postgres:Dnect2016@192.168.0.81:5432/testdb",
+    modules={"models": ["src.fastapi_authly.models.user"]},
+    generate_schemas=True,
+    add_exception_handlers=True,
+)
+
+# 方式 1: 使用 JwtConfig 实例（推荐）
+config = AuthConfig(
+    jwt=JwtConfig(
+        secret_key="django-insecure-7qi2d#57gzg7br&sx-1n9c16)kf979m)jg+%vu^z80ti_#&d*_",
+        algorithm="HS256",
+        access_token_expires_minutes=30,
+        refresh_token_expires_days=7,
+    ),
+    router_prefix="/auth",
+)
+
+# 方式 2: 使用字典更新（也可以）
+# config = AuthConfig(
+#     jwt={
+#         "secret_key": "your-secret-key-change-in-production",
+#         "algorithm": "HS256",
+#         "access_token_expires_minutes": 30,
+#     },
+#     router_prefix="/auth",
+#     token_url="login",
+# )
+
+# 方式 3: 使用默认配置，然后通过环境变量覆盖
+# 设置环境变量: AUTH_JWT__SECRET_KEY=your-secret-key
+# config = AuthConfig(
+#     router_prefix="/auth",
+#     token_url="login",
+# )
+
+deps = AuthDependencyConfig(
+    user_repository=TortoiseUserRepository(),
+)
+
+# 注册认证路由
+auth_router = create_auth_router(config=config, dependencies=deps)
+app.include_router(auth_router)
+
+# 设置 Scalar 文档
+setup_scalar_docs(app, docs_url="/docs", static_url="/static")
+
+@app.get("/")
+async def root():
+    return {"message": "FastAPI Authly 测试应用已启动"}
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8001)

{fastapi_authly-0.1.2 → fastapi_authly-0.1.4}/uv.lock

@@ -625,9 +625,10 @@ wheels = [
 
 [[package]]
 name = "fastapi-authly"
-version = "0.1.0"
+version = "0.1.3"
 source = { editable = "." }
 dependencies = [
+    { name = "asyncpg" },
     { name = "emails" },
     { name = "fastapi" },
     { name = "jinja2" },
@@ -638,6 +639,7 @@ dependencies = [
     { name = "python-jose", extra = ["cryptography"] },
     { name = "python-multipart" },
     { name = "tortoise-orm", extra = ["psycopg"] },
+    { name = "uvicorn" },
 ]
 
 [package.optional-dependencies]
@@ -662,6 +664,7 @@ tortoise = [
 [package.metadata]
 requires-dist = [
     { name = "alembic", marker = "extra == 'sqlalchemy'", specifier = ">=1.12.0" },
+    { name = "asyncpg", specifier = ">=0.31.0" },
     { name = "emails", specifier = ">=0.6.0" },
     { name = "faker", marker = "extra == 'test'", specifier = ">=20.0.0" },
     { name = "fastapi", specifier = ">=0.100.0" },
@@ -680,6 +683,7 @@ requires-dist = [
     { name = "sqlalchemy", marker = "extra == 'sqlalchemy'", specifier = ">=2.0.0" },
     { name = "tortoise-orm", extras = ["asyncpg"], marker = "extra == 'tortoise'", specifier = ">=0.20.0" },
     { name = "tortoise-orm", extras = ["psycopg"], specifier = ">=0.25.3" },
+    { name = "uvicorn", specifier = ">=0.40.0" },
 ]
 provides-extras = ["tortoise", "sqlalchemy", "docs", "test"]
 
@@ -1908,6 +1912,20 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/39/08/aaaad47bc4e9dc8c725e68f9d04865dbcb2052843ff09c97b08904852d84/urllib3-2.6.3-py3-none-any.whl", hash = "sha256:bf272323e553dfb2e87d9bfd225ca7b0f467b919d7bbd355436d3fd37cb0acd4", size = 131584, upload-time = "2026-01-07T16:24:42.685Z" },
 ]
 
+[[package]]
+name = "uvicorn"
+version = "0.40.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "h11" },
+    { name = "typing-extensions", marker = "python_full_version < '3.11'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c3/d1/8f3c683c9561a4e6689dd3b1d345c815f10f86acd044ee1fb9a4dcd0b8c5/uvicorn-0.40.0.tar.gz", hash = "sha256:839676675e87e73694518b5574fd0f24c9d97b46bea16df7b8c05ea1a51071ea", size = 81761, upload-time = "2025-12-21T14:16:22.45Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/3d/d8/2083a1daa7439a66f3a48589a57d576aa117726762618f6bb09fe3798796/uvicorn-0.40.0-py3-none-any.whl", hash = "sha256:c6c8f55bc8bf13eb6fa9ff87ad62308bbbc33d0b67f84293151efe87e0d5f2ee", size = 68502, upload-time = "2025-12-21T14:16:21.041Z" },
+]
+
 [[package]]
 name = "watchdog"
 version = "6.0.0"

fastapi_authly-0.1.2/CHANGELOG_SCALAR.md

@@ -1,84 +0,0 @@
-# Scalar 文档功能集成说明
-
-## 改动概述
-
-已将 Scalar API 文档功能集成到 `fastapi-authly` 包中，包含所有必要的静态资源文件。用户只需导入并使用 `setup_scalar_docs` 函数即可启用文档功能，无需手动管理静态文件。
-
-## 新增文件
-
-1. **`src/fastapi_authly/docs.py`**: 文档功能模块
-   - `setup_scalar_docs()`: 主要函数，用于设置 Scalar 文档
-   - `get_static_dir()`: 获取包内静态文件目录路径
-
-2. **`src/fastapi_authly/static/scalar/`**: 静态资源目录
-   - `standalone.js`: Scalar JavaScript 文件
-   - `style.css`: Scalar CSS 样式文件
-
-3. **示例文件**:
-   - `examples/use_scalar_docs.py`: 基本使用示例
-   - `examples/complete_example.py`: 完整使用示例
-   - `docs/SCALAR_DOCS_USAGE.md`: 详细使用文档
-
-## 修改文件
-
-1. **`src/fastapi_authly/__init__.py`**:
-   - 添加 `setup_scalar_docs` 的导入和导出
-
-2. **`README.md` 和 `README.zh.md`**:
-   - 添加 Scalar 文档功能的使用说明
-
-## 使用方法
-
-### 基本使用
-
-```python
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs
-
-app = FastAPI(title="My API")
-setup_scalar_docs(app)
-```
-
-### 自定义配置
-
-```python
-setup_scalar_docs(
-    app,
-    docs_url="/api-docs",
-    static_url="/assets",
-    title="Custom API Docs",
-    openapi_url="/openapi.json"
-)
-```
-
-## 优势
-
-1. **零配置**: 无需手动复制静态文件
-2. **可移植**: 安装包后即可使用
-3. **简单**: 一行代码启用
-4. **灵活**: 支持自定义 URL 和配置
-
-## 构建和发布
-
-静态文件会自动包含在构建的包中，因为它们在 `src/fastapi_authly/static/` 目录下，属于包的一部分。
-
-构建和发布流程不变：
-
-```bash
-uv build
-uv publish --token your-token
-```
-
-## 测试
-
-安装包后，可以这样测试：
-
-```python
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs
-
-app = FastAPI(title="Test API")
-setup_scalar_docs(app)
-
-# 运行应用后，访问 http://localhost:8000/docs 即可看到文档
-```

fastapi_authly-0.1.2/docs/SCALAR_DOCS_USAGE.md

@@ -1,121 +0,0 @@
-# Scalar API 文档功能使用指南
-
-## 概述
-
-`fastapi-authly` 现在内置了 Scalar API 文档支持，包含所有必要的静态资源文件。你无需手动复制静态文件，只需一行代码即可启用美观的 API 文档。
-
-## 快速开始
-
-### 基本使用
-
-```python
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs
-
-app = FastAPI(title="My API")
-
-# 一行代码启用 Scalar 文档
-setup_scalar_docs(app)
-```
-
-这将会：
-- 自动挂载静态文件到 `/static`
-- 创建文档页面到 `/docs`
-- 使用应用的 `title` 和 `openapi_url`
-
-### 完整示例
-
-```python
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs, create_auth_router, AuthConfig, AuthDependencyConfig
-from fastapi_authly.contrib.tortoise_pg import TortoiseUserRepository
-from tortoise.contrib.fastapi import register_tortoise
-
-app = FastAPI(
-    title="Complaint API",
-    description="Complaint Data Streaming API",
-    version="2.0.1",
-)
-
-# 初始化数据库
-register_tortoise(
-    app,
-    db_url="postgres://user:password@localhost:5432/mydb",
-    modules={"models": ["fastapi_authly.models.user"]},
-    generate_schemas=True,
-    add_exception_handlers=True,
-)
-
-# 配置认证路由
-config = AuthConfig()
-deps = AuthDependencyConfig(user_repository=TortoiseUserRepository())
-auth_router = create_auth_router(config=config, dependencies=deps)
-app.include_router(auth_router)
-
-# 设置 Scalar 文档
-setup_scalar_docs(app, docs_url="/docs", static_url="/static")
-
-if __name__ == "__main__":
-    import uvicorn
-    uvicorn.run(app, host="0.0.0.0", port=8000)
-```
-
-## 自定义配置
-
-```python
-setup_scalar_docs(
-    app,
-    docs_url="/api-docs",        # 自定义文档 URL
-    static_url="/assets",        # 自定义静态文件前缀
-    title="Custom API Docs",     # 自定义标题
-    openapi_url="/openapi.json"  # 自定义 OpenAPI schema URL
-)
-```
-
-## 参数说明
-
-- `app` (必需): FastAPI 应用实例
-- `docs_url` (可选): 文档页面 URL，默认为 `"/docs"`
-- `static_url` (可选): 静态文件 URL 前缀，默认为 `"/static"`
-- `title` (可选): 文档标题，默认使用 `app.title`
-- `openapi_url` (可选): OpenAPI schema URL，默认使用 `app.openapi_url`
-
-## 注意事项
-
-1. **静态文件位置**: 静态文件已经打包在 `fastapi_authly` 包内，无需手动复制
-2. **URL 冲突**: 确保 `docs_url` 和 `static_url` 不与现有路由冲突
-3. **OpenAPI Schema**: 确保 FastAPI 应用已启用 OpenAPI schema（默认启用）
-
-## 迁移指南
-
-如果你之前手动配置了 Scalar 文档，可以按以下步骤迁移：
-
-### 之前的方式
-
-```python
-app.mount("/static", StaticFiles(directory="static"), name="static")
-
-@app.get("/docs", include_in_schema=False)
-async def scalar_html(_app):
-    html_content = f"""
-    <!DOCTYPE html>
-    ...
-    """
-    return HTMLResponse(content=html_content)
-```
-
-### 现在的方式
-
-```python
-from fastapi_authly import setup_scalar_docs
-
-# 一行代码替代上面的所有配置
-setup_scalar_docs(app, docs_url="/docs", static_url="/static")
-```
-
-## 优势
-
-1. **无需手动管理静态文件**: 所有静态资源已打包在包内
-2. **简单易用**: 一行代码即可启用
-3. **可移植**: 其他项目安装包后即可使用，无需额外配置
-4. **可定制**: 支持自定义 URL 和标题

fastapi_authly-0.1.2/examples/complete_example.py

@@ -1,63 +0,0 @@
-"""
-完整示例：展示如何像原项目一样使用 fastapi-authly 的文档功能
-"""
-
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs, create_auth_router, AuthConfig, AuthDependencyConfig
-from fastapi_authly.contrib.tortoise_pg import TortoiseUserRepository
-from tortoise.contrib.fastapi import register_tortoise, tortoise_exception_handlers
-from contextlib import asynccontextmanager
-
-# 生命周期管理
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    # 启动时执行
-    yield
-    # 关闭时执行
-
-# 创建 FastAPI 应用
-app = FastAPI(
-    title="Complaint API",
-    description="Complaint Data Streaming API",
-    version="2.0.1",
-    exception_handlers=tortoise_exception_handlers(),
-    lifespan=lifespan,
-    docs_url="/old_docs",  # 保留旧的 docs，但使用 Scalar
-)
-
-# 初始化数据库
-register_tortoise(
-    app,
-    db_url="postgres://user:password@localhost:5432/mydb",
-    modules={"models": ["fastapi_authly.models.user"]},
-    generate_schemas=True,
-    add_exception_handlers=True,
-)
-
-# 配置认证路由
-config = AuthConfig()
-deps = AuthDependencyConfig(user_repository=TortoiseUserRepository())
-auth_router = create_auth_router(config=config, dependencies=deps)
-app.include_router(auth_router)
-
-# 设置 Scalar 文档
-# 这会自动挂载静态文件并创建文档页面
-setup_scalar_docs(
-    app,
-    docs_url="/docs",  # 文档页面 URL
-    static_url="/static",  # 静态文件 URL 前缀（与原来的保持一致）
-)
-
-# 其他 API 路由
-@app.get("/")
-async def root():
-    return {"message": "API is running"}
-
-if __name__ == "__main__":
-    import uvicorn
-    uvicorn.run(
-        app,
-        host="0.0.0.0",
-        port=3040,
-        loop="uvloop",
-    )

fastapi_authly-0.1.2/examples/use_scalar_docs.py

@@ -1,53 +0,0 @@
-"""
-使用示例：如何在项目中使用 fastapi-authly 的 Scalar 文档功能
-"""
-
-from fastapi import FastAPI
-from fastapi_authly import setup_scalar_docs, create_auth_router, AuthConfig, AuthDependencyConfig
-from fastapi_authly.contrib.tortoise_pg import TortoiseUserRepository
-from tortoise.contrib.fastapi import register_tortoise
-
-# 创建 FastAPI 应用
-app = FastAPI(
-    title="My API",
-    description="My API with Scalar Documentation",
-    version="1.0.0",
-)
-
-# 配置认证路由（示例）
-config = AuthConfig()
-deps = AuthDependencyConfig(user_repository=TortoiseUserRepository())
-auth_router = create_auth_router(config=config, dependencies=deps)
-app.include_router(auth_router)
-
-# 设置 Scalar 文档
-# 这会自动：
-# 1. 挂载静态文件到 /static
-# 2. 创建文档页面到 /docs
-setup_scalar_docs(
-    app,
-    docs_url="/docs",  # 文档页面 URL
-    static_url="/static",  # 静态文件 URL 前缀
-)
-
-# 或者自定义配置
-# setup_scalar_docs(
-#     app,
-#     docs_url="/api-docs",  # 自定义文档 URL
-#     static_url="/assets",  # 自定义静态文件前缀
-#     title="Custom API Docs",  # 自定义标题
-#     openapi_url="/openapi.json",  # 自定义 OpenAPI schema URL
-# )
-
-# 初始化数据库（示例）
-register_tortoise(
-    app,
-    db_url="postgres://user:password@localhost:5432/mydb",
-    modules={"models": ["fastapi_authly.models.user"]},
-    generate_schemas=True,
-    add_exception_handlers=True,
-)
-
-if __name__ == "__main__":
-    import uvicorn
-    uvicorn.run(app, host="0.0.0.0", port=8000)

fastapi_authly-0.1.2/test.py

@@ -1,177 +0,0 @@
-
-"""
-题 1（入门）
-给定 nums = [1, 2, 3, 4, 5]，用 map 得到每个元素的平方，输出为列表。
-
-"""
-numbers = [1,2,3,4,5,6,7,8,9]
-content = map(lambda x: x**2, numbers)
-print(list(content))
-
-
-"""
-给定 words = [" Alice ", "BOB", "cHaRlIe "]
-用 map 把每个元素转换成：去掉两端空格 + 全部小写。
-"""
-
-a = 'Word'
-words = [" Alice ", "BOB", "cHaRlIe "]
-
-new_words = map(lambda x: x.strip().lower(), words)
-
-print(list(new_words))
-
-"""
-### 题 3（类型转换 + 容错）
-给定 `raw = ["1", "2", "x", "3", ""]`  
-实现一个转换函数：能转成 int 的转 int，不能转的返回 `None`。  
-用 `map` 得到结果列表。
-"""
-
-raw = ["1", "2", "x", "3", ""]
-
-def change(x):
-    try:
-        return int(x)
-    except ValueError:
-        return None
-
-content = map(change, raw)
-
-print(list(content))
-
-
-"""
-### 题 4（多个 iterable）
-给定：
-
-```python
-a = [1, 2, 3, 4]
-b = [10, 20, 30]
-```
-
-用 `map` 生成 `a[i] + b[i]` 的列表，并解释为什么结果长度是多少。
-"""
-
-a = [1, 2, 3, 4]
-b = [10, 20, 30]
-
-def _add(x,y):
-    print(x,y)
-
-content = map(lambda x,y:x+y, a, b)
-
-print(list(content))
-# 长度为最短的那个可迭代对象的长度，因为灰爆出stop什么来着
-
-
-"""
-### 题 5（嵌套数据处理）
-给定：
-
-```python
-records = [
-    {"name": "alice", "score": "98"},
-    {"name": "bob", "score": "87"},
-    {"name": "cathy", "score": "100"},
-]
-```
-
-用 `map` 输出一个列表：每个元素是 `(NAME_UPPER, score_int)`。
-"""
-
-records = [
-    {"name": "alice", "score": "98"},
-    {"name": "bob", "score": "87"},
-    {"name": "cathy", "score": "100"},
-]
-
-content = map(lambda x: (x["name"].upper(), x["score"]), records)
-
-print(list(content))
-
-
-"""
-### 题 6（惰性验证题）
-写一段最短代码证明：`map` 不会立刻执行函数，而是在迭代时执行。  
-要求：必须能从输出看出来“什么时候调用”。
-"""
-
-numbers = [1,2,3,4,5,6,7,8,9]
-
-content = map(lambda x: print(f"当前{x}"), numbers)
-
-print(next(content))
-
-
-"""
-### 题 7（组合题：map + filter）
-给定 `nums = list(range(-5, 6))`  
-用 **filter 先筛掉负数**，再用 **map 转平方**，输出列表。  
-（要求用函数式写法，不用列表推导式。）
-"""
-nums = list(range(-5, 6))
-
-filtered = filter(lambda x: x > 0, nums)
-
-new_nums = map(lambda x: x**2, filtered)
-print(list(new_nums))
-
-"""
-### 题 8（进阶：并行处理 + 缺失值）
-给定：
-
-```python
-names = ["alice", "bob", "cathy", "dan"]
-scores = ["100", "", "87", "x"]
-```
-
-目标输出一个列表：`["Alice:100", "Bob:NA", "Cathy:87", "Dan:NA"]`  
-规则：分数能转 int 就用该数字，否则用 `"NA"`。  
-要求：用 `map`，并尽量把逻辑放进一个清晰的转换函数里。
-
-"""
-names = ["alice", "bob", "cathy", "dan"]
-scores = ["100", "", "87", "x"]
-
-def chang(name,score):
-    try:
-        score = int(score)
-        return f"{name}:{score}"
-    except ValueError:
-        return f"{name}:NA"
-
-content = map(chang, names, scores)
-
-print(list(content))
-
-print(callable(chang))
-
-"""
-### 题 9（较难：实现你自己的 map）
-实现一个函数 `my_map(func, iterable)`，返回一个**生成器**，行为尽量像 `map`（惰性、一次产出一个）。  
-然后用它跑一下题 1 的例子验证。
-"""
-
-from typing import Callable
-
-def my_map(func: Callable, iterable):
-    if not callable(func):
-        raise "func 应该是一个函数"
-
-    # todo 应该增加iterable 的判断，判断他是一个可迭代的对象
-
-    # todo 应该增加可是传递多个可迭代对象，但是我不知道怎么做
-    for item in iterable:
-        yield func(item)
-
-numbers = [1,2,3,4,5,6,7,8,9]
-
-content = my_map(lambda x: x**2, numbers)
-
-print(next(content))
-
-print(list(content))
-
-
-print(map.__doc__)