跳转到主要内容

DKIST科学数据处理管道使用的通用任务类,用于处理DKIST数据。

项目描述

此存储库与dkist-processing-coredkist-processing-*instrument*协同工作,形成DKIST校准处理堆栈。

用法

此存储库中的类应作为任何DKIST处理管道任务的基础。科学任务应子类化ScienceTaskL0ToL1Base

每个类都基于一个抽象基类,其中run方法留供开发人员填充任务应执行的必要步骤。然后,此类用作工作流程和调度引擎的调用对象。

示例

from dkist_processing_common.tasks.base import ScienceTaskL0ToL1Base


class RemoveArtifacts(ScienceTaskL0ToL1Base):
    def run(self):
        # task code here
        total = 2 + 5

部署

dkist-processing-common部署到PyPI

开发

在本地机器上执行测试有两个先决条件

  • Redis。本地机器上需要运行redis实例。测试将使用localhost的默认主机ip和6379端口连接到数据库。

  • RabbitMQ。本地机器上需要运行rabbitmq实例。测试将使用localhost的默认主机和5672端口连接到服务间总线。

要本地运行测试,请克隆存储库,并使用测试额外功能以可编辑模式安装包。

git clone git@bitbucket.org:dkistdc/dkist-processing-common.git
cd dkist-processing-common
pre-commit install
pip install -e .[test]
# Redis must be running
pytest -v --cov dkist_processing_common

变更日志

当您对此存储库进行任何更改时,必须附带更改日志文件。此存储库的更改日志使用towncrier软件包。下一个发布版本的更改日志条目作为单个文件(每个更改一个)添加到changelog/目录中。

编写更改日志条目

应将伴随更改的更改日志条目添加到changelog/目录。此目录中文件的名称遵循特定的模板

<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst

字段具有以下含义

  • <PULL REQUEST NUMBER>:这是拉取请求的编号,因此人们可以从更改日志条目跳转到BitBucket上的差异。

  • <TYPE>:这是更改的类型,必须是以下描述的值之一。

  • <COUNTER>:这是一个可选字段,如果您对同类型的更改进行了多次更改,则可以在后续更改中附加计数器,例如,对于同一个PR中的两个错误修复更改,可以分别为它们使用100.bugfix.rst100.bugfix.1.rst

可能的类型列表定义在pyproject.toml的towncrier部分,类型包括:

  • feature:这是一个新的代码功能。

  • bugfix:这是一个修复错误的更改。

  • doc:一个文档更改。

  • removal:公共API的弃用或删除。

  • misc:任何不适合其他地方的小更改,例如对包基础设施的更改。

发布时渲染更改日志

在即将进行发布标记之前,您必须首先运行towncrier以渲染更改日志。以下是该步骤:

  • 使用您想要标记的版本号运行towncrier build –version vx.y.z

  • 同意让towncrier删除片段。

  • 添加并提交您的更改。

  • 标记发布。

注意:如果您忘记将更改日志条目添加到标记的发布(手动或通过towncrier自动)中,则Bitbucket管道将失败。为了能够使用相同的标记,您必须在本地及其远程分支上删除它。

# First, actually update the CHANGELOG and commit the update
git commit

# Delete tags
git tag -d vWHATEVER.THE.VERSION
git push --delete origin vWHATEVER.THE.VERSION

# Re-tag with the same version
git tag vWHATEVER.THE.VERSION
git push --tags origin main

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

dkist-processing-common-10.2.1.tar.gz (495.7 kB 查看哈希值)

上传时间

支持者