用于row api v4的官方python sdk
linode-api4的Python项目详细描述
林诺德API4
python中Linode API v4的正式python库。
此库当前处于测试版。
安装
pip install linode_api4
从源头建设
要生成和安装此软件包:
- 克隆此存储库
- ./setup.py install
使用量
签出Getting Started guide开始使用此库,或阅读 the docs用于大量文档。
示例
有关演示的简单用例,请参见Install on a Linode示例项目 这个图书馆的许多特点。
贡献
测试
测试位于tests目录中。调用测试时,请确保 在这个项目的根目录中。把整个套房 支持的python版本,请使用tox:
tox
运行tox还运行pylint和coverage报告。
测试套件使用test/fixtures中存储为json的fixture。这些文件 包含来自api的净化json响应-文件名是名为 要生成响应,请用下划线替换任何斜杠。
测试类应该扩展test.base.ClientBaseCase。这为他们提供了 使用self.client,设置为使用的LinodeClient对象 测验。重要的是,此对象发出的任何get请求都将被模拟为 从测试夹具中检索数据。这包括使用 这个客户机(以及与扩展相关的模型)。
在测试GET请求以外的请求时,self.mock_post(和 其他http动词的等效方法)可以在with块中使用 模拟预期的请求类型。这些函数接受相对路径 从应该返回的api基url,例如:
# this should return the result of GET /linode/instances/123 with self.mock_post('/linode/instances/123'): linode = self.client.linode.instance_create('g6-standard-2', 'us-east') self.assertEqual(linode.id, 123) # passes
文件
这个库是用Sphinx记录的。文档位于docs目录中。 构建文档的最简单方法是在其中运行sphinx-autobuild。 文件夹。
库中的类和函数应使用符合sphinx的注释 将用于自动生成 图书馆。参与时,请确保更新文档或包括新的 docstrings(如果适用)用于保持库的文档最新 而且很有用。
缺少或不准确的文档是一个错误。如果你注意到 这个图书馆的文件已过期或不清楚,请 open an issue让我们意识到这个问题。