correos-seguimiento 0.3.0

:warning: 进行中 :warning

此库是访问Seguimiento Correos JSON API的Python包装器。

操作

• API将提供跟踪运输所需的所有数据。使用此模块，您可以检查包裹是否已交付或重贴标签，并获得新的跟踪代码。

有关API的更多信息，请参阅文档。

安装

$ pip install correos-seguimiento

使用

检查运输是否已交付

>>> from correos_seguimiento.services.shipment import TrackingShipment
>>>
>>> shipment = TrackingShipment("XXX", "XXX", "PQXXX10721392610108021C").build()
>>> shipment.is_delivered()
False
>>> shipment.is_delivered()
True

检查运输是否重贴标签并获得新的跟踪代码

>>> from correos_seguimiento.services.shipment import TrackingShipment
>>>
>>> shipment = TrackingShipment("XXX", "XXX", "PQXXX10721392610108021C").build()
>>> shipment.is_delivered()
False
>>> shipment.is_relabeled()
True
>>> shipment.get_relabeled_shipment_code()
"PY53VM9100000810108640T"

检查运输是否已退回

>>> from correos_seguimiento.services.shipment import TrackingShipment
>>>
>>> shipment = TrackingShipment("XXX", "XXX", "PQXXX10721392610108021C").build()
>>> shipment.is_returned()
False
>>> shipment.is_returned()
True

开发

设置环境

1. 安装pyenv

curl https://pyenv.run | bash

2. 构建Python版本

pyenv install  3.7.13

3. 创建virtualenv

pyenv virtualenv 3.7.13 correos-seguimiento

4. 安装依赖项

pyenv exec pip install -r requirements.txt

5. 安装pre-commit钩子

pyenv exec pre-commit install

测试HTTP请求

我们使用Pytest的HTTP录制插件：pytest-recording。

使用VCR，我们可以捕获HTTP响应，然后使用它们执行测试。

添加新测试

• 公开所需的envvars。在配置环境部分中查找它们
• 使用pytest命令执行测试
• 如果您正在编写执行请求的新测试，则应运行

$ pytest --record-mode=once path/to/your/test

• 您可能需要为特定测试记录请求。在这种情况下，请确保只运行受影响的测试并运行

$ pytest --record-mode=rewrite path/to/your/test

• 将新的cassetes添加到提交并推送它们。
• CI使用cassetes在测试中模拟HTTP响应。

运行测试套件

$ tox

格式化

我们使用Black作为格式化器。首先提交，运行black命令

$ black .
All done! ✨ 🍰 ✨
29 files left unchanged.

更暗

Black是一个优秀的格式化工具，但要维护您的代码而不每次都执行black命令，您可以配置您的IDE以使用darker来在保存文件时仅格式化已更改或添加的代码。

发布流程

按照以下步骤更新CHANGELOG.md

1. 添加合并请求中缺少的任何条目。
2. 复制[Unreleased]标题。
3. 将第二个Unreleased替换为版本号，后跟当前日期。请从以前的版本中复制确切的格式。

然后，您可以发布并将包发布到PyPi

1. 更新setup.py中的VERSION变量，使其与CHANGELOG中指定的版本相匹配。
2. 为团队批准这些更改，打开一个合并请求。
3. 合并它，在该合并提交上添加一个git标签并推送。
4. 一旦管道成功通过，您的包就已经发布。