跳转到主要内容

Toggle API的Python包装器

项目描述

toggl-python-api-client

Toggl 是一个“疯狂简单的计时跟踪”服务。

这个特定的库是基于Python的REST客户端,用于与Toggle API接口,利用 requests

这个库是一个纯API客户端,帮助其他Python应用程序与Toggl接口。我创建这个项目主要是为了帮助我在工作中处理一个更大的内部项目,同时也在Python中试试水。

其他人的项目

已经有一个类似的库,toggl_target,尽管它更像是一个应用程序,客户端API不是一个独立的仓库。我从那里借鉴了一些客户端API的想法/概念,但我需要的是一个仅用于帮助我的更大应用程序的客户端API。

使用方法

PyPI包

pip install python-toggl

手动安装

下载到您选择的任何位置并执行以下操作。

from toggl.api_client import TogglClientApi

settings = {
    'token': 'xxx',
    'user_agent': 'your app name'
}
toggle_client = TogglClientApi(settings)

response = toggle_client.get_workspaces()

依赖关系

测试依赖关系

要运行测试,您需要以下包

测试

/tests 下创建的测试主要是集成测试,而不是严格的单元测试。它们包括离线和在线(实时)测试。

离线

tests/tests_offline.py

这些测试是针对API客户端的逻辑。它们不连接到实际的Toggle服务器 - 而是使用 httpretty 来模拟响应。示例响应包括在 tests/json_responses 中,并基于主API的V8版本和报告API的V2版本。

在线/实时

tests/tests_live.py

这些测试是为了检查与Toggle API的连接,并确保客户端如预期地处理来自Toggle的实时响应。

为了避免将敏感数据添加到版本控制中,没有包含API凭证。要启用实时测试,- 将 tests/tests_live_config.json.sample 复制为 tests/tests_live_config.json - 根据需要更新 tests/tests_live_config.json 上的设置

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

python-toggl-1.1.0.tar.gz (10.8 kB 查看哈希值)

上传时间 源代码

构建分发

python_toggl-1.1.0-py3-none-any.whl (11.1 kB 查看哈希值)

上传时间 Python 3

由支持