FastHX 项目使用教程

1. 项目的目录结构及介绍

FastHX 是一个为 FastAPI 提供服务端渲染的库，其目录结构如下：

• ./fasthx/

  • __init__.py: 初始化模块，使得可以在其他文件中导入此模块。
  • app.py: 包含 FastHX 的核心逻辑。
  • renderers/: 包含不同渲染引擎的集成。
  • templatetags/: 模板标签，用于扩展模板功能。

• ./examples/

  • 包含了使用 FastHX 的示例项目，展示了如何集成不同的模板引擎。

• ./tests/

  • 测试代码，确保 FastHX 的功能按预期工作。

• ./docs/

  • 文档文件夹，包含了项目的文档内容。

• ./static/

  • 静态文件目录，如 CSS、JavaScript 文件等。

• ./templates/

  • 模板文件目录，存放 HTML 模板。

• .gitignore

  • 指定 Git 忽略的文件和目录。

• LICENSE

  • 项目使用的 MIT 许可证。

• README.md

  • 项目说明文件，包含项目介绍和如何使用的信息。

• pyproject.toml

  • 项目配置文件，定义了项目的元数据和依赖。

2. 项目的启动文件介绍

项目的启动文件通常是 main.py 或 app.py，以下是一个简单的启动文件示例：

from fastapi import FastAPI
from fasthx import HTMY

app = FastAPI()
htmy = HTMY()

@app.get("/")
@htmy.page("index.html")
async def index():
    # 业务逻辑
    pass

在这个启动文件中，我们创建了一个 FastAPI 应用实例和一个 FastHX 的 HTMY 实例。然后，我们定义了一个路由，使用 HTMY 的 page 装饰器来渲染一个 HTML 页面。

3. 项目的配置文件介绍

项目的配置文件通常放在项目根目录下，名为 config.py 或 settings.py，以下是一个配置文件的示例：

from pydantic import BaseSettings

class Settings(BaseSettings):
    app_name: str = "FastHX Example"
    database_url: str = "sqlite:///./test.db"

    class Config:
        env_file = ".env"

settings = Settings()

在这个配置文件中，我们定义了一个 Settings 类，它继承自 BaseSettings。我们设置了默认的应用名称和数据库名称，并指定了环境变量文件 .env，使得我们可以通过环境变量来覆盖这些设置。

使用配置文件时，可以在应用的任何地方通过 settings 对象来访问这些配置值。