Tornado Boilerplate 项目技术文档

1. 安装指南

环境要求

• Python 2.7 或更高版本
• Tornado 3.2 或更高版本

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/your-repo/tornado-boilerplate.git
   cd tornado-boilerplate
   

2. 安装依赖：

   pip install -r requirements/common.txt
   

   如果需要开发环境或生产环境的依赖，可以分别使用 dev.txt 或 production.txt。

3. 初始化子模块（如果存在）：

   git submodule init
   git submodule update
   

4. 配置环境变量： 根据项目需求，配置 settings.py 中的相关设置。

2. 项目的使用说明

启动服务器

在项目根目录下运行以下命令启动 Tornado 服务器：

python app.py

默认情况下，服务器会在 localhost:8888 上运行。

目录结构

• handlers/：存放所有的 Tornado RequestHandler。
• lib/：存放非 Tornado 请求处理器的 Python 模块和包。
• logconfig/：日志配置模块。
• media/：存放 CSS、JavaScript 和图片资源。
• requirements/：存放不同环境的依赖文件。
• templates/：存放项目级别的模板文件。
• vendor/：存放作为 git 子模块的 Python 包依赖。
• environment.py：修改 PYTHONPATH 以允许从 apps/、lib/ 和 vendor/ 目录导入。
• fabfile.py：用于部署的 Fabric 脚本。
• app.py：主 Tornado 应用程序，同时也是启动 Tornado 服务器的可执行文件。
• settings.py：应用程序设置文件。

日志配置

日志配置在 logconfig 目录中，默认情况下，服务器部署时会记录到 syslog，开发模式下会记录到控制台。

模板使用

项目包含一个 base.html 模板，定义了多个块，如 title、site_css、css、extra_head、header、content、footer、site_js 和 js。

3. 项目API使用文档

基本API调用

在 handlers/ 目录中定义的 RequestHandler 可以通过 HTTP 请求进行调用。例如：

curl http://localhost:8888/your-endpoint

日志API

在每个需要日志记录的文件顶部，可以使用以下代码初始化日志记录器：

import logging
logger = logging.getLogger('five.' + __name__)

4. 项目安装方式

手动安装

1. 克隆项目仓库。
2. 安装依赖。
3. 配置环境变量。
4. 启动服务器。

使用 Fabric 部署

项目包含一个 fabfile.py，可以使用 Fabric 进行自动化部署。具体命令如下：

fab deploy

通过以上步骤，您可以顺利安装并使用 tornado-boilerplate 项目。