加拿大众议院信息抓取与 republish 项目技术文档

2024-12-17 22:46:49作者：羿妍玫Ivan

1. 安装指南

环境要求

Python 3.12 或更高版本
Docker 和 Docker Compose
PostgreSQL 数据库（推荐）

安装步骤

克隆项目代码：

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

配置 Docker：
- 复制 config-examples 目录中的 docker-compose.yml 文件到项目根目录。
- 运行以下命令启动 Docker 容器：
```
docker-compose up
```
安装依赖：
- 进入 Docker 容器内部：
```
docker exec -it your-container-id /bin/bash
```
- 在容器内部安装 Python 依赖：
```
pip install -r requirements.txt
```
配置数据库：
- 确保 PostgreSQL 数据库已启动并运行。
- 创建数据库并配置数据库连接信息，参考 settings.py 中的数据库配置部分。
加载数据：
- 从 openparliament.ca/data-download/ 下载 PostgreSQL 数据 dump。
- 使用 pg_restore 命令将数据导入到 PostgreSQL 数据库中：
```
pg_restore -d your_database_name your_dump_file.sql
```

2. 项目的使用说明

启动应用

在 Docker 容器中运行以下命令启动 Django 应用：
```
python manage.py runserver
```
访问 http://localhost:8000 即可查看应用。

功能概述

该应用抓取并 republish 加拿大众议院的相关信息。
主要功能包括：
- 抓取众议院议员、法案、辩论、委员会等信息。
- 将抓取的信息 republish 到一个网站上。

自定义配置

如果需要自定义网站名称或 logo，请确保不使用 openparliament.ca 的名称或 logo，除非用于确认。

3. 项目API使用文档

API 概述

该项目的 API 主要用于获取众议院的相关信息，如议员、法案、辩论等。
API 使用 Django REST Framework 实现。

API 示例

获取所有议员信息：
```
GET /api/members/
```
获取特定法案信息：
```
GET /api/bills/{bill_id}/
```

API 认证

部分 API 需要认证，请在请求头中添加 Authorization 字段：
```
Authorization: Token your_token_here
```

4. 项目安装方式

使用 Docker 安装

推荐使用 Docker 进行安装，具体步骤见安装指南。

手动安装

如果不想使用 Docker，可以手动安装 Python 环境和依赖，具体步骤如下：
1. 安装 Python 3.12 或更高版本。
2. 安装 PostgreSQL 数据库。
3. 克隆项目代码并安装依赖：
```
git clone https://github.com/your-repo/your-project.git
cd your-project
pip install -r requirements.txt
```
4. 配置数据库并启动应用。

数据库配置

项目支持多种数据库，但推荐使用 PostgreSQL。

在 settings.py 中配置数据库连接信息：

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'your_database_name',
        'USER': 'your_database_user',
        'PASSWORD': 'your_database_password',
        'HOST': 'localhost',
        'PORT': '5432',
    }
}