开源项目教程：Beancount 导入器

1. 项目的目录结构及介绍

china_bean_importers 项目是一个用于Beancount的导入脚本，支持多种中国金融工具的数据导入。项目的目录结构如下：

• __init__.py: 初始化Python模块，使得项目可以被当作一个包来使用。

• config.example.py: 配置文件示例，包含所有可配置的选项和解释。

• LICENSE: 项目使用的MIT许可协议。

• README.md: 项目说明文件，包含项目的基本信息和如何使用。

• pyproject.toml: Python项目配置文件。

• .gitignore: Git忽略文件，用于指定哪些文件和目录不应该被版本控制系统跟踪。

• china_bean_importers/: 包含所有导入器的Python代码。

  • wechat.py: 微信支付导入器。
  • alipay_web.py: 支付宝（网页端）导入器。
  • alipay_mobile.py: 支付宝（手机端）导入器。
  • boc_credit_card.py: 中国银行信用卡导入器。
  • boc_debit_card.py: 中国银行借记卡导入器。
  • ...: 其他银行和支付工具的导入器。

• tests/: 测试目录，用于存放项目的单元测试代码。

2. 项目的启动文件介绍

此项目的启动主要是通过Python直接运行脚本或者通过pip安装后作为库使用。

• 安装: 可以通过pip命令安装本项目，安装命令如下：

  pip3 install china-bean-importers
  

  或者，你可以克隆整个仓库到本地：

  git clone https://github.com/jiegec/china_bean_importers
  

  然后在本地的项目目录中安装：

  cd china_bean_importers
  pip install --editable .
  

• 运行: 运行导入器之前，需要先配置好config.py文件。以下是一个简单的配置和使用示例：

  from china_bean_importers import wechat, alipay_web, alipay_mobile, boc_credit_card, boc_debit_card
  from china_bean_importer_config import config
  
  CONFIG = [
      wechat.Importer(config),
      alipay_web.Importer(config),
      alipay_mobile.Importer(config),
      boc_credit_card.Importer(config),
      boc_debit_card.Importer(config),
  ]
  
  # 接下来可以根据需要调用CONFIG中的导入器进行数据导入
  

3. 项目的配置文件介绍

项目的配置文件是config.example.py，它包含了所有可以自定义的配置选项。在使用前，需要复制这个文件为config.py，然后根据实际情况进行编辑。

以下是一些主要的配置选项：

• importers: 包含每个导入器需要的特定配置，如账户映射、分类映射等。
• card_narration_whitelist 和 card_narration_blacklist: 用于过滤可能在其他导入器中出现的交易描述。
• card_accounts: 记录各类卡账户的最后四位数字，用于自动化账户匹配。
• pdf_passwords: 用于解密加密的PDF文件。
• unknown_expense/income_account: 在无法匹配情况下使用的支出/收入账户。
• detail_mapping: 用于从交易描述、对手等信息中匹配目标账户、标签等信息。

确保所有的配置信息填写正确，以便导入器能够正确地解析和处理你的财务数据。