Uber Rides Python SDK 使用教程

Uber Rides Python SDK 使用教程

rides-python-sdkUber Rides Python SDK (beta)项目地址:https://gitcode.com/gh_mirrors/ri/rides-python-sdk

1. 项目的目录结构及介绍

Uber Rides Python SDK 的目录结构如下：

rides-python-sdk/
├── example/
│   ├── authorize_driver.py
│   ├── authorize_rider.py
│   ├── config.yaml
│   ├── oauth2_driver_session_store.yaml
│   ├── oauth2_rider_session_store.yaml
│   ├── request_ride.py
│   └── tests/
├── uber_rides/
│   ├── auth.py
│   ├── client.py
│   ├── conf.py
│   ├── errors.py
│   ├── models.py
│   ├── session.py
│   └── __init__.py
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── requirements.txt
├── setup.cfg
├── setup.py

目录介绍

• example/: 包含示例代码，演示如何使用 SDK 进行授权、请求乘车等操作。
• uber_rides/: 包含 SDK 的核心代码，包括认证、客户端、配置、错误处理、模型和会话等模块。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• Makefile: 构建文件。
• README.rst: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

项目的启动文件主要位于 example/ 目录下，以下是一些关键的启动文件：

• authorize_rider.py: 用于通过授权码流程获取 UberRidesClient 实例，适用于乘客端。
• authorize_driver.py: 用于通过授权码流程获取 UberRidesClient 实例，适用于司机端。
• request_ride.py: 用于创建乘车请求的示例代码。

启动文件示例

以 authorize_rider.py 为例，该文件的主要功能是通过授权码流程获取 UberRidesClient 实例：

# example/authorize_rider.py
from uber_rides.auth import AuthorizationCodeGrant
from uber_rides.client import UberRidesClient

auth_flow = AuthorizationCodeGrant(
    client_id,
    scopes,
    client_secret,
    redirect_uri
)

session = auth_flow.get_session(redirect_url)
client = UberRidesClient(session, sandbox_mode=True)
credentials = session.oauth2credential

3. 项目的配置文件介绍

项目的配置文件主要位于 example/ 目录下，以下是一些关键的配置文件：

• config.yaml: 包含应用的凭证信息，如 client_id, client_secret, redirect_uri 等。
• oauth2_rider_session_store.yaml: 存储乘客端的 OAuth2 凭证信息。
• oauth2_driver_session_store.yaml: 存储司机端的 OAuth2 凭证信息。

配置文件示例

以 config.yaml 为例，该文件的主要内容如下：

client_id: 'YOUR_CLIENT_ID'
client_secret: 'YOUR_CLIENT_SECRET'
redirect_uri: 'YOUR_REDIRECT_URI'
scopes: ['profile', 'history', 'request']

在运行示例代码之前，需要编辑 config.yaml 文件并添加从 Uber 开发者仪表板获取的应用凭证。

---

以上是 Uber Rides Python SDK 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该开源项目。

rides-python-sdkUber Rides Python SDK (beta)项目地址:https://gitcode.com/gh_mirrors/ri/rides-python-sdk