Gargoyle 项目技术文档

1. 安装指南

Gargoyle 是一个基于 Django 的平台，允许开发者根据条件开关应用程序的功能。尽管原项目已不再维护，但 YPlan 团队维护了一个活跃的分支。以下是安装指南：

1.1 环境要求

• Python 3.x
• Django 1.2 及以上版本

1.2 安装步骤

1. 使用 pip 安装 Gargoyle：

   pip install gargoyle-yplan
   

2. 在 Django 项目的 settings.py 文件中添加 gargoyle 到 INSTALLED_APPS：

   INSTALLED_APPS = [
       ...
       'gargoyle',
       ...
   ]
   

3. 运行数据库迁移：

   python manage.py migrate
   

2. 项目的使用说明

2.1 功能开关

Gargoyle 允许开发者根据条件开关应用程序的功能。以下是基本使用步骤：

1. 在代码中定义开关：

   from gargoyle import gargoyle
   
   @gargoyle.switch_is_active('my_feature')
   def my_feature_view(request):
       # 功能代码
       pass
   

2. 在管理界面中管理开关：

   • 访问 Django 管理界面，找到 Gargoyle 部分。
   • 创建或编辑开关，设置条件和状态。

2.2 条件设置

Gargoyle 支持多种条件设置，如用户角色、时间、特定用户等。开发者可以根据需求自定义条件。

3. 项目API使用文档

3.1 开关管理API

Gargoyle 提供了一套 API 用于管理功能开关。以下是常用 API 示例：

1. 检查开关状态：

   from gargoyle import gargoyle
   
   if gargoyle.is_active('my_feature'):
       # 功能代码
       pass
   

2. 创建新开关：

   gargoyle.add_switch('new_feature', active=True)
   

3. 删除开关：

   gargoyle.remove_switch('old_feature')
   

3.2 条件设置API

Gargoyle 允许开发者通过 API 设置条件：

1. 添加条件：

   gargoyle.add_condition('my_feature', 'user', 'is_staff', True)
   

2. 删除条件：

   gargoyle.remove_condition('my_feature', 'user', 'is_staff')
   

4. 项目安装方式

Gargoyle 的安装方式非常简单，只需通过 pip 安装即可：

pip install gargoyle-yplan

安装完成后，按照上述步骤配置 Django 项目即可开始使用 Gargoyle 的功能开关管理。

---

通过以上文档，用户可以快速了解并使用 Gargoyle 项目，实现灵活的功能开关管理。