SwiftBeanCountCompassCardMapper

CI Status Documentation percentage License: MIT Latest version platforms supported: linux | macOS | iOS | watchOS | tvOS SPM compatible

本项目是 SwiftBeanCount 的一部分,请查看主文档此处

什么

这是一个小型库,用于将从 Compass Card 下载的数据(通过 CompassCardDownloader)转换为 Beancount 格式(通过 SwiftBeanCountModel)。

Beancount 元数据

该库依赖于您的 Beancount 文件中的元数据来查找您的账户。请在您的 Compass Card 资产账户中添加 importer-type: "compass-card"card-number: "XXXXXXXXXXXXXXXXXXXX"。要自动添加费用账户,请将 compass-card-expense: "XXXXXXXXXXXXXXXXXXXX" 以及卡号添加到账户 - 对于自动加载,请使用 compass-card-load: "XXXXXXXXXXXXXXXXXXXX"

如何

  1. 加载您的账本,例如通过 SwiftBeanCountParser
  2. 使用账本创建 SwiftBeanCountCompassCardMapper 的实例
  3. 通过 CompassCardDownloader 下载您要转换的余额和交易
  4. 在 mapper 上使用 createBalancecreateTransactions 来转换下载的数据

另请查看完整文档此处

用法

该库支持 Swift Package Manager,因此只需在您的 Package.swift 中添加一个依赖项

.package(url: "https://github.com/Nef10/SwiftBeanCountCompassCardMapper.git", .exact(from: "X.Y.Z")),

注意:根据语义版本控制,所有 < 1.0.0 的版本更改都可能是破坏性的,因此目前请使用 .exact

版权

虽然我的代码根据 MIT 许可证获得许可,但源代码仓库可能包含 Compass Card、TransLink 或其他实体的名称或其他商标;这些元素的潜在使用限制仍然适用,并且不受软件许可证的约束。API 设计同样适用。我与 TransLink 没有任何关联,仅仅是一名客户。