用于python的devo软件开发工具包。
devo-sdk的Python项目详细描述
devo python sdk
这是直接从python访问devo的sdk。它可用于:
- 将事件和文件发送到devo。
- 提出疑问。
- 管理延迟的任务。
要求
python的devo sdk需要python 3.5+
兼容性
- 测试了Python3.5、3.6和3.7的兼容性
快速启动
安装sdk
您可以使用easy_install
或pip
:
#option 1
easy_install devo-sdk
#option 2
pip install devo-sdk
您可以使用源文件,也可以关闭项目:
#option 3
python setup.py install
#option 4
pip install .
#option 5 - dev option
pip install -e .
文件
您在docs文件夹中为sdk的每个部分提供了特定的文档:
贡献
见PyLibs contributing guide。
欢迎提出拉取和合并请求
端点
发送者
要使用devo sdk发送数据,首先根据访问的区域选择所需的端点:
- 美国:
- url:us.elb.relay.logtrust.net
- 端口:443
- eu:
- url:eu.elb.relay.logtrust.net
- 端口:443
- vdc:
- url:es.elb.relay.logtrust.net
- 端口:443
在devo的官方文档中有更多信息,Sending data to Devo。
美国石油学会
要使用API执行请求,请首先根据访问的区域选择所需的端点:
- 美国:https://apiv2-us.devo.com/search/query
- eu:https://apiv2-eu.devo.com/search/query
- vdc:https://apiv2-es.devo.com/search/query
在devo的官方文档中有更多信息,REST API。
凭证
要获得使用此sdk所需的访问凭据,您必须在DEVO中拥有一个帐户。
有关详细信息,请查看security credentials信息。
证书
您需要使用三个文件(cert、key和chain)将数据安全地发送到devo。 管理员用户可以在x.509选项卡中的administration→credentials中找到它们。
API授权
您可以使用域API密钥和API密钥对请求进行签名。这是一对证书, Devo帐户拥有。管理员用户可以在“访问密钥”选项卡中的administration→credentials中找到它们。
启动测试
运行测试脚本
可以从sdk的主文件夹运行测试 要启动此脚本,您需要系统中加载的环境变量,或sdk根目录中具有正确值的environment.env文件,因为要测试所有sdk功能,必须连接到devo以进行发送和提取数据的测试。您有一个名为environment.env.example
顺便说一句,tcp测试在客户端或devo开发人员系统中都会失败。
~/projects/devo-python-sdk > python setup.py test
~/projects/devo-python-sdk > python run_tests.py
您可以添加选项“coverage”来创建关于测试的html报告。
~/projects/devo-python-sdk > python run_tests.py --coverage
使用unittest命令运行
您可以在unittest documentation中看到引用
对于以下命令:
python -m unittest discover -p "*.py"
如果从sdk的根目录启动此命令,则需要在 所有需要连接到devo的测试的系统都可以工作,不能使用environment.env文件 就像剧本里那样。
联系我们
您可以通过support@devo.com与我们联系。
许可证
麻省理工学院许可证
(c)2019年德沃公司
兹免费准许任何人一份 此软件和相关文档文件(“软件”),用于处理 不受限制的软件,包括但不限于 使用、复制、修改、转到、发布、分发、再授权和/或出售 软件,并允许向其提供软件的人员这样做, 必须满足以下条件:
上述版权公告及本许可公告须包括在 软件的拷贝或大部分。
本软件按“原样”提供,无任何形式的保证,明示或 默示的,包括但不限于适销性、适用性的保证 为了特定的目的和不受侵犯。在任何情况下,作者或 版权持有人应对任何索赔、损害或其他责任负责,无论 在诉讼或合同中,侵权行为或其他方式,由 与软件的连接或软件的使用或其他交易