Been 项目技术文档

1. 安装指南

1.1 环境要求

在安装 Been 之前，请确保您的系统满足以下要求：

• Python 3.6 或更高版本
• CouchDB 或 Redis 作为数据存储
• Git（如果需要从 Git 仓库读取 Markdown 文件）

1.2 安装步骤

1. 克隆 Been 项目仓库：

   git clone https://github.com/chromakode/been.git
   

2. 进入项目目录：

   cd been
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 配置数据存储：

   • 如果使用 CouchDB，请确保 CouchDB 服务已启动，并在 config.py 中配置 CouchDB 的连接信息。
   • 如果使用 Redis，请确保 Redis 服务已启动，并在 config.py 中配置 Redis 的连接信息。

5. 启动 Been 服务：

   python runserver.py
   

2. 项目的使用说明

2.1 数据源配置

Been 支持从多种数据源获取事件，如 GitHub 提交、Reddit 评论和推文。您可以在 config.py 中配置数据源。例如，配置 GitHub 数据源：

SOURCES = {
    'github': {
        'username': 'your_github_username',
        'token': 'your_github_token',
    }
}

2.2 数据存储

Been 支持将事件存储在 CouchDB 或 Redis 中。您可以在 config.py 中配置存储方式：

STORE = {
    'type': 'couchdb',  # 或 'redis'
    'host': 'localhost',
    'port': 5984,  # CouchDB 默认端口
    'db_name': 'been',  # 数据库名称
}

2.3 本地 Markdown 文件

Been 可以从本地目录或 Git 仓库读取 Markdown 文件。您可以在 config.py 中配置 Markdown 文件的路径：

MARKDOWN = {
    'path': '/path/to/markdown/files',
    'git_repo': 'https://github.com/your_username/your_repo.git',  # 可选
}

3. 项目 API 使用文档

3.1 获取事件列表

您可以通过以下 API 获取事件列表：

GET /api/events

响应示例：

[
    {
        "id": "event_id",
        "source": "github",
        "type": "commit",
        "timestamp": "2023-10-01T12:00:00Z",
        "data": {
            "message": "Commit message",
            "repo": "repository_name"
        }
    }
]

3.2 获取单个事件

您可以通过以下 API 获取单个事件的详细信息：

GET /api/events/{event_id}

响应示例：

{
    "id": "event_id",
    "source": "github",
    "type": "commit",
    "timestamp": "2023-10-01T12:00:00Z",
    "data": {
        "message": "Commit message",
        "repo": "repository_name"
    }
}

3.3 获取 Markdown 文件内容

您可以通过以下 API 获取 Markdown 文件的内容：

GET /api/markdown/{file_name}

响应示例：

{
    "content": "Markdown file content"
}

4. 项目安装方式

4.1 通过 Docker 安装

如果您希望使用 Docker 安装 Been，可以按照以下步骤操作：

1. 克隆 Been 项目仓库：

   git clone https://github.com/chromakode/been.git
   

2. 进入项目目录：

   cd been
   

3. 构建 Docker 镜像：

   docker build -t been .
   

4. 运行 Docker 容器：

   docker run -d -p 5000:5000 been
   

4.2 通过 Pip 安装

如果您希望通过 Pip 安装 Been，可以按照以下步骤操作：

1. 安装 Been：

   pip install been
   

2. 配置数据存储和数据源：

   • 在 config.py 中配置 CouchDB 或 Redis 的连接信息。
   • 在 config.py 中配置数据源。

3. 启动 Been 服务：

   been runserver
   

通过以上步骤，您可以成功安装并使用 Been 项目。希望本文档能帮助您更好地理解和使用 Been。