pyrolific

研究人员访问 Prolific API 的非官方客户端库。

从 https://github.com/openapi-generators/openapi-python-client 和 https://docs.prolific.com/docs/api-docs/public-openapi 生成。

用法

首先，创建一个客户端

from pyrolific import Client

client = Client(base_url="https://api.prolific.com")

如果您要调用的端点需要身份验证，请使用 AuthenticatedClient 代替

from pyrolific import AuthenticatedClient

client = AuthenticatedClient(base_url="https://https://api.prolific.com", token="SuperSecretToken")

AuthenticatedClient 似乎与 api 不兼容，您仍然需要在端点调用上包含一个授权 kwarg。

from pyrolific.api.studies import get_api_v1_studies
get_api_v1_studies.sync(client=client, authorization='Token SuperSecretToken')

** 文档其余部分为生成器自动生成的未修改输出 **

或使用异步版本执行相同操作

from pyrolific.models import MyDataModel
from pyrolific.api.my_tag import get_my_data_model
from pyrolific.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

默认情况下，当您调用 HTTPS API 时，它将尝试验证 SSL 是否正常工作。大多数时候使用证书验证是高度推荐的，但有时您可能需要使用自定义证书捆绑包对服务器进行身份验证（特别是内部服务器）。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

您还可以完全禁用证书验证，但请注意，这是安全风险。

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken", 
    verify_ssl=False
)

在生成的 Client 类上还有更多设置，可以让你控制更多运行时行为，请查看该类的文档字符串以获取更多信息。

注意事项

1. 每个路径/方法组合都成为具有四个函数的 Python 模块

   1. sync：阻塞请求，如果成功返回解析后的数据，否则返回 None
   2. sync_detailed：阻塞请求，始终返回一个 Request，如果请求成功，则可选地设置 parsed
   3. asyncio：类似于 sync，但异步而不是阻塞
   4. asyncio_detailed：类似于 sync_detailed，但异步而不是阻塞

2. 所有路径/查询参数和体都成为方法参数。

3. 如果您的端点有任何标签，第一个标签将用作函数的模块名称（如上面的 my_tag）

4. 没有标签的任何端点都将位于 pyrolific.api.default

构建/发布此客户端

此项目使用 Poetry 来管理依赖和打包。以下是一些基础知识

1. 更新 pyproject.toml 中的元数据（例如作者、版本）
2. 如果您使用的是私有仓库，请使用 Poetry 进行配置
   1. poetry config repositories.<你的仓库名称> <你的仓库url>
   2. poetry config http-basic.<你的仓库名称> <用户名> <密码>
3. 使用 poetry publish --build -r <你的仓库名称> 发布客户端或，如果是公开 PyPI，只需 poetry publish --build

如果您想在不发布的情况下将此客户端安装到另一个项目中（例如开发）则

1. 如果该项目 正在使用 Poetry，您可以从该项目直接执行 poetry add <此客户端路径>
2. 如果该项目没有使用 Poetry
   1. 使用 poetry build -f wheel 构建wheel
   2. 从其他项目安装该wheel pip install <wheel路径>