threedi API的客户端
项目描述
threedi-api-client
一个用于与3Di API交互的Python库
自由软件：BSD许可证
功能
使用https://openapi-generator.tech/生成的面向对象API交互。
异步支持。
高级文件下载和上传实用程序函数。
安装
我们建议使用pip安装此软件包
pip install --user threedi-api-client
如果需要异步支持，请按以下方式安装
pip install --user threedi-api-client[aio]
致谢
OpenAPI客户端已使用OpenAPI生成器（https://openapi-generator.tech/）生成，该生成器遵循Apache License 2.0许可。
此软件包使用Cookiecutter和audreyr/cookiecutter-pypackage项目模板创建。
历史
4.1.8 (2024-10-03)
版本 3.4.3
自定义结果文件
水质扩散系数
4.1.7 (2024-06-05)
从现场开始进行模拟
4.1.6 (2024-04-12)
使用生成器版本 v4.4.0 生成
4.1.6b (2023-12-14)
水质和其他添加项。
4.1.5 (2023-11-21)
更新到框架版本 3.2.75
4.1.4 (2023-06-19)
允许通过file_upload函数传递（额外）HTTP头部。
4.1.3 (2023-06-14)
版本 3.2.34
使用构建包而不是setuptools构建发布版本。
重写发布工作流程以使用支持的github action进行github发布。
4.1.2 (2023-04-25)
公开发布。
4.1.2b (2023-03-13)
更新到框架版本 3.2.6
修复重试上传时的超时问题。
4.1.1 (2022-11-21)
还改进了对异步上传/下载功能中HTTP代理的支持。
4.1.0 (2022-11-21)
通过禁用aiohttp自动添加“content-type”头部，在aio/files.py中的上传/下载函数支持S3（对象存储）的临时URL。
将（异步）下载的默认套接字读取超时增加到60秒。
将上传的默认套接字连接超时增加到30秒。
使同步和异步的ApiException相同。
改进了对异步API客户端的HTTP代理支持。
支持2022年11月的API（3.0）发布。
4.0.1 (2022-06-08)
支持个人API令牌身份验证。
添加了OAuth2令牌和OAuth2令牌刷新功能（适用于公共和私有客户端）。
将服务器端MD5检查设为可选，以考虑到S3预签名URL无法使用自定义头部（如Content-MD5），除非它们包含在签名过程中。
允许在不提供刷新令牌的情况下使用API客户端。
添加了通过客户端凭证授权获得的OAuth2令牌的自动刷新。
4.0.0 (2022-02-11)
包含新的ThreediApi客户端的第一个稳定版本
当从API获取的数据无法通过客户端验证成功验证时显示警告。
4.0.0b4 (2022-01-26)
将simulation_templates重命名为simulation-templates
4.0.0b3 (2022-01-26)
添加了Threedimodel is_valid字段，作为inp_success的别名
添加了Simulation threedicore_version字段和cloned_from字段
添加了status端点和version端点
4.0.0b2 (2022-01-17)
修复分发。
4.0.0b1 (2022-01-17)
添加了对周期性（目前仅限每日）横向文件的支持
支持从文件中读取1D初始水位。
在未知枚举值的情况下显示警告，而不是引发错误。
为异步/同步下载/上传函数添加了回调支持
添加了结构控制文件上传
添加了对THREEDI_API_ACCESS_TOKEN和THREEDI_API_REFRESH_TOKEN配置变量的支持
在threedi_api_client.openapi / threedi_api_client.api.openapi中添加了一个新的、版本化的API。如果使用旧的一个，将发出警告（openapi_client）。
现在应省略API_HOST设置中的API版本（例如https://api.3di.live而不是https://api.3di.live/v3.0）。如果包含版本，将发出警告。
将V3AlphaApi设为V3BetaApi的子类，将V3BetaApi设为V3Api的超集。
在ThreediApi中添加了retries，这使得可以设置重试策略。对于异步客户端，包含
将异步文件上传/下载的默认超时从5分钟总时间更改为仅套接字超时5秒。这允许上传更大的文件。
修改了上传的默认套接字读取超时从5秒到10分钟，以适应大文件上传。
3.0.29 (2021-06-02)
将文档移动到readthedocs，并将项目名称从threedi-api-client（而不是threedi-openapi-client）统一。
3.0.28 (2021-05-04)
将一般设置重命名为物理设置。
3.0.27 (2021-04-26)
停止支持Python 3.5。
添加了上传和下载文件功能（同步和异步）。
3.0.26 (2021-04-07)
恢复了泄漏功能。由于本地API定义不同步而丢失。
3.0.25 (2021-04-07)
添加了模拟设置。
3.0.24 (2021-03-19)
将泄漏添加到API。
3.0.23 (2021-03-03)
删除了打印语句。
3.0.22 (2021-02-12)
修复：自动token续期的过期函数不起作用。
3.0.21 (2021-01-21)
添加了新的过滤器和使用统计模型。
3.0.20 (2021-01-07)
修复threedi_api_client导入。
3.0.19 (2021-01-07)
使用python -m pyest…运行pytest以确保当前路径添加到PYTHONPATH。
3.0.18 (2021-01-07)
确保aio模块也得到分发。
3.0.17 (2020-12-01)
添加了边界条件（文件）上传。
3.0.16 (2020-11-04)
将aiohttp锁定到3.6.3，对于>= 3.7.0 yarl和mulitdict需要用GCC构建。
删除了lateral/file/upload端点。
添加了重试Lizard（结果）后处理的端点。
3.0.15 (2020-10-14)
将用户添加到lizardrasterrain和lizard raster sources&sinks。
3.0.14 (2020-10-14)
重试发布。
3.0.13 (2020-10-14)
添加了范围/点swagger定义。
将filelateral添加到swagger。
3.0.12 (2020-10-13)
重试发布。
3.0.11 (2020-10-13)
将用户添加到Lizard raster rain和Lizard raster sources sinks。
添加了gh-actions发布流水线。
3.0.10 (2020-09-29)
添加了大量侧向事件。
3.0.9 (2020-09-16)
添加了表格和内存结构控制。
3.0.8 (2020-09-04)
将timestructurecontrol重命名为timestructurecontrols。
3.0.7 (2020-08-20)
在文档中添加示例笔记本。
3.0.6 (2020-07-31)
更新退出代码定义。
3.0.5 (2020-07-31)
将exit_code字段添加到状态资源。
添加了破坏图端点。
3.0.4 (2020-07-15)
添加了泵排放图端点。
在合同上添加了更多过滤选项。
3.0.4b3（2020-07-10）
在所有地方添加了id字段。
3.0.4b2（2020-07-08）
使用生成器版本v4.3.0生成。
修复了threedimodel在模拟资源上的问题（应该是整数而不是字符串）。
3.0.4b1（2020-07-07）
不需要进行损害估计。
3.0.3 (2020-06-16)
更改了Lizard后处理概述端点。
3.0.2 (2020-06-12)
为模拟端点添加了用户名过滤器。
3.0.1 (2020-06-09)
添加了统计端点。
更改了Lizard后处理端点（不向后兼容，但打算仅由Lizard使用）。
3.0 (2020-05-25)
官方生产发布。
3.0.b24（2020-05-22）
事件上的所有uid字段应为只读。
3.0.b23（2020-05-20）
添加了风全局拖系数。
3.0.b22（2020-05-18）
将max_rate添加到操作中。
3.0.b21（2020-05-15）
状态字段crash_report已成为详细信息。
3.0.b20（2020-05-11）
将破坏和更多字段添加到potentialbreaches。
3.0.b19（2020-04-24）
文件过滤器排除/包含模拟状态。
3.0.b18（2020-04-24）
将“active”添加到inpy-version资源。
3.0.b17（2020-04-20）
添加了icontains过滤器。
3.0.b16（2020-04-10）
将uuid字段添加到初始保存状态序列化器。
3.0.b15（2020-04-01）
添加了模拟WebSocket通道概述端点。
3.0.b14（2020-03-23）
添加了栅格编辑处理端点。
3.0.b13（2020-03-20）
将水位图端点拆分为水流和水位图端点。
添加了水头图端点。
3.0.b12（2020-03-10）
添加了水位图端点。
3.0.b11（2020-03-06）
添加了用户端点。
将用户端点更改为配置文件端点。
添加了更多过滤器。
3.0b10（2020-02-19）
模拟模型现在有一个“tags”字段。
3.0.b9（2020-02-12）
支持交互式模拟。
结果API端点。
3.0.b8（2020-02-10）
编辑常量和时序风事件。
3.0.b7（2020-02-03）
添加了风。
添加了可视化端点。
3.0.b6（2020-01-29）
3.0.b5发布中出现问题，下次重试。
3.0.b5（2020-01-27）
栅格编辑，事件uuids。
3.0.b4（2019-12-12）
本地雨事件。
3.0.b3（2019-12-09）
对依赖项‘six’和‘urllib3’的要求不那么严格，以避免在Lizard处遇到pipenv解析问题。
3.0.b2 (2019-12-02)
将‘set_pump_discharge’更改为‘set_pump_capacity’。
3.0.b1 (2019-11-28)
更新API描述。
栅格资源过滤。
3.0.b0 (2019-11-28)
第一个3.0发布候选版本。
所有swagger模式都自动保存为schemas/swagger_xxx.yaml。
0.0.23 (2019-11-26)
修复发布问题。
0.0.22 (2019-11-26)
添加了初始水位栅格和后处理。
0.0.21 (2019-11-18)
修复了ThreediApiClient构造函数无法与配置关键字和.env文件一起使用的问题。
添加了初始水位。
0.0.20 (2019-11-11)
将模拟和模拟_id添加到状态序列化器。
当当前JWT令牌有效期小于5分钟时，自动获取新的JWT令牌。
使用mkdocs进行文档编写。
0.0.17.3 (2019-11-04)
测试发布。
0.0.17.2 (2019-11-04)
测试发布。
0.0.17.1 (2019-11-01)
添加边界模型。
0.0.17c (2019-11-01)
将边界添加到模拟事件，并更新文档。
0.0.17b (2019-10-31)
批量边界条件。
0.0.17a (2019-10-31)
边界条件。
0.0.17 (2019-10-30)
限制兼容的Python版本。
0.1.9 (2019-10-30)
添加资源状态。
0.1.8 (2019-10-17)
添加定时控制。
0.1.7 (2019-09-25)
横向现在有id字段。
使用集成。
0.1.6 (2019-09-04)
添加geojson/gridadmin/rasters上传和下载。
0.1.5 (2019-07-03)
更新文件上传。
0.1.4 (2019-06-24)
包含模块。
0.1.3 (2019-06-24)
修复包名。
0.1.2 (2019-06-24)
PyPi发布。
0.1.1 (2019-06-21)
包含更多端点。
0.1.0 (2019-05-10)
PyPI上的第一个发布。
下载文件
下载您平台对应的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源代码分发
构建分发
散列值 for threedi_api_client-4.1.8-py2.py3-none-any.whl
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | d3055ba1cbd04cd236b8b10497cd5fb2c3269508cb3f9588ea5e271ac0da3405 |
|
| MD5 | 7a115eccabf27e3a66c689647542dc8e |
|
| BLAKE2b-256 | 1d2515008e98a7e10dc668ae63223bddff98bc1f070dfa7988caf1717871a52e |