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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-authly
-Version: 0.1.2
+Version: 0.1.3
 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/

fastapi_authly-0.1.3/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.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi-authly"
-version = "0.1.2"
+version = "0.1.3"
 description = "A modular authentication system for FastAPI with OAuth2, JWT, and password recovery"
 readme = "README.md"
 license = {text = "MIT"}

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

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

{fastapi_authly-0.1.2 → fastapi_authly-0.1.3}/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.3}/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.3}/src/fastapi_authly/core/config.py

@@ -58,6 +58,27 @@ class AuthConfig(BaseSettings):
         env_prefix="AUTH_",
         extra="ignore",
     )
+    
+    # 属性访问器：直接访问 jwt 中的属性，兼容现有代码
+    @property
+    def secret_key(self) -> str:
+        """JWT secret key"""
+        return self.jwt.secret_key
+    
+    @property
+    def algorithm(self) -> str:
+        """JWT algorithm"""
+        return self.jwt.algorithm
+    
+    @property
+    def access_token_expire_minutes(self) -> Optional[int]:
+        """Access token expiration in minutes (compatible with auth.py)"""
+        return self.jwt.access_token_expires_minutes
+    
+    @property
+    def refresh_token_expire_days(self) -> int:
+        """Refresh token expiration in days"""
+        return self.jwt.refresh_token_expire_days
 
 _config = AuthConfig()
 

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)