togglwrapper 1.2.0

TOGGL

Toggl是自由时间跟踪软件。

功能

• 为您处理身份验证：只需提供一次api令牌
• 最完整的python包装器：实现所有v8 api。
• 从pypi方便地安装
• 易于向自定义URL发出请求
• python2和python3兼容

安装

$ pip install togglwrapper

快速启动

>>>fromtogglwrapperimportToggl>>>toggl=Toggl('your_api_token')``>>>toggl.User.get(){u'data':{u'achievements_enabled':True,u'api_token':u'your_api_token',u'email':u'your_email@domain.com',u'fullname':u'Your Name',...}>>>toggl.Clients.get()[{u'at':u'2015-07-02T14:27:59+00:00',u'id':12031893,u'name':u'Client Name',u'wid':3928}]>>>toggl.Workspaces.get()[{u'admin':True,u'api_token':u'your_api_token',u'id':1234,u'name':u"Your workspace",...}]>>>toggl.Clients.create({"client":{"name":"Very Big Company","wid":1234}}){u'data':{u'id':294021,u'name':u'Very Big Company',u'wid':1234}}

自定义请求

假设为一个新的toggl对象释放了一个新的端点：addresses。这个假设的端点位于https://www.toggl.com/api/v8/addresses。我们可以获取所有地址，通过id获取特定地址，或者通过post创建新地址。

我们可以在toggl客户机上使用这些方法，因此不必等待支持新端点的togglwrapper的新版本：

>>>fromtogglwrapperimportToggl>>>toggl=Toggl('your_api_token')>>>toggl.get('/addresses')...>>>toggl.get('/addresses/{address_id}')...>>>toggl.post('/addresses',data={"address":{"name":"Billing Address 1","address":"123 Main St."}})...

toggl.put和toggl.delete也可用。

文档

在这里找到完整的文档：http://togglwrapper.readthedocs.org/en/latest/

API端点文档

有关哪些字段是必需的，哪些端点是可用的，请参见Toggl API docs

在本地运行测试

使用virtualenv+virtualenvwrapper保持环境隔离：

1. 创建一个测试虚拟机
2. 安装测试要求
3. python tests.py

命令行输出示例：

$ mkvirtualenv twtests  # if creating the virtualenv for the first time
Running virtualenv [...]
[...]
(twtest) $ pip install -r test-requirements.txt
Collecting [...]
[...]
(twtest) $ python tests.py
.......................................................
----------------------------------------------------------------------
Ran 55 tests in 0.414s

OK
(twtest) $ deactivate
$