GAE/Bingo 技术文档

1. 安装指南

首先，您需要从项目仓库下载 GAE/Bingo 的源代码，并将其 gae_bingo/ 文件夹复制到您的 App Engine 项目的根目录中。

接着，在您的 App Engine 项目的 app.yaml 文件中，添加以下处理器定义：

handlers:
- url: /gae_bingo/static
  static_dir: gae_bingo/static
- url: /gae_bingo/tests/.*
  script: gae_bingo/tests/main.py
- url: /gae_bingo/.*
  script: gae_bingo/main.py

然后，在您的 App Engine 项目的 cron.yaml 文件中，添加以下任务定义：

cron:
- description: persist gae bingo experiments to datastore
  url: /gae_bingo/persist
  schedule: every 5 minutes

最后，修改您想要 A/B 测试的 WSGI 应用程序，通过包装 gae_bingo WSGI 中间件来整合 GAE/Bingo：

# 示例现有应用程序
application = webapp.WSGIApplication(...existing application...)

# 添加以下内容
from gae_bingo.middleware import GAEBingoWSGIMiddleware
application = GAEBingoWSGIMiddleware(application)

2. 项目的使用说明

GAE/Bingo 允许您通过简单的代码实现 A/B 测试。以下是一个基础的使用示例：

from gae_bingo.gae_bingo import ab_test, bingo

# 开始一个 A/B 测试，返回 True 或 False
use_new_button_design = ab_test("new button design")

# ...然后在适当的时候记录一个转换...
bingo("new button design")

您可以访问 /gae_bingo/dashboard 来控制实验和查看统计结果。

3. 项目 API 使用文档

• ab_test(name, [alternatives=None, conversion_name=None]): 开始一个 A/B 测试，返回一个布尔值或指定的替代品。
• bingo(name): 记录一个转换。

更多 API 使用细节和示例代码请参考项目代码库或官方文档。

4. 项目安装方式

项目安装遵循以上提到的步骤，主要包括：

• 下载并复制 gae_bingo/ 文件夹到您的 App Engine 项目。
• 配置 app.yaml 和 cron.yaml 文件以集成 GAE/Bingo。
• 使用 GAEBingoWSGIMiddleware 包装您的 WSGI 应用程序。

确保遵循以上步骤以确保 GAE/Bingo 在您的项目中正确安装和运行。