Friendly Public Transport Format (FPTF) 使用教程

1. 项目介绍

Friendly Public Transport Format (FPTF) 是一个用于描述公共交通数据的格式规范。它旨在为API、库和数据集提供一个简单、直观的公共交通数据表示方法。FPTF 的设计灵感来自于 GTFS（General Transit Feed Specification），但更加注重易用性和可消费性。

FPTF 支持多种公共交通模式，包括火车、公交车、轮船、出租车、缆车、飞机、汽车、自行车和步行。它通过 JSON 和 ndjson 格式来表示数据，使得数据易于解析和处理。

2. 项目快速启动

安装

首先，克隆 FPTF 项目到本地：

git clone https://github.com/public-transport/friendly-public-transport-format.git
cd friendly-public-transport-format

使用示例

以下是一个简单的 FPTF 数据示例，表示一个从 A 站到 B 站的火车行程：

{
  "type": "journey",
  "id": "12345",
  "legs": [
    {
      "origin": {
        "type": "station",
        "id": "A",
        "name": "Station A"
      },
      "destination": {
        "type": "station",
        "id": "B",
        "name": "Station B"
      },
      "departure": "2023-10-01T08:00:00+00:00",
      "arrival": "2023-10-01T09:00:00+00:00",
      "mode": "train",
      "name": "ICE 123"
    }
  ]
}

解析 FPTF 数据

假设你已经有一个 FPTF 格式的 JSON 文件 journey.json，你可以使用 Python 来解析它：

import json

# 读取 FPTF 数据
with open('journey.json', 'r') as file:
    data = json.load(file)

# 打印行程信息
print(f"行程 ID: {data['id']}")
for leg in data['legs']:
    print(f"从 {leg['origin']['name']} 到 {leg['destination']['name']}")
    print(f"出发时间: {leg['departure']}")
    print(f"到达时间: {leg['arrival']}")
    print(f"交通工具: {leg['mode']} - {leg['name']}")

3. 应用案例和最佳实践

应用案例

FPTF 可以用于多种场景，包括但不限于：

• 公共交通应用开发：开发者可以使用 FPTF 格式来构建公共交通查询和路线规划应用。
• 数据集成：FPTF 可以作为不同公共交通数据源之间的桥梁，方便数据的集成和交换。
• 数据可视化：通过 FPTF 格式，可以轻松地将公共交通数据可视化，帮助用户更好地理解交通网络。

最佳实践

• 标准化数据格式：确保所有数据都符合 FPTF 规范，以便于数据的解析和处理。
• 实时数据更新：如果可能，尽量使用实时数据来更新 FPTF 数据，以提供更准确的交通信息。
• 模块化设计：在开发应用时，尽量将 FPTF 数据的解析和处理模块化，以便于维护和扩展。

4. 典型生态项目

pyHaFAS

pyHaFAS 是一个基于 FPTF 的 Python 库，用于访问和处理公共交通数据。它支持多种公共交通模式，并且可以与 FPTF 数据无缝集成。

FPTI-JS

FPTI-JS 是一个基于 JavaScript 的 FPTF 接口，用于构建公共交通应用。它提供了一系列工具和方法，帮助开发者快速构建基于 FPTF 的应用。

FPTF-Converter

FPTF-Converter 是一个数据转换工具，用于将其他公共交通数据格式（如 GTFS）转换为 FPTF 格式。它可以帮助开发者快速迁移和集成现有数据。

通过这些生态项目，开发者可以更高效地使用 FPTF 格式，构建功能强大的公共交通应用。