健树

在KiCad和InventTree中快速创建零件

演示视频：fast_forward：完整演示：fast_forward：KiCad 演示

介绍

Ki-nTree（发音为“Key Entry”或“Key 'n' Tree”）旨在：

• 自动化 KiCad 库零件的零件创建
• 自动创建 InventTree 零件的零件
• 在 KiCad 和 InvenTree 之间同步零件数据

Ki-nTree 适用于：

• Digi-Key、Mouser和LCSC 庞大的零件数据库和免费 API
• 由@peeter123构建和维护的很棒的开源Digi-Key API python 库
• 由@eeintech构建和维护的Mouser Python API
• 由@SchrodingersGat构建和维护的很棒的开源InvenTree 库存管理系统
• KiCad（当然！）和他们的开源库工具

重要的提示

由于维护带宽有限，Ki-nTree 版本0.5.x和更新版本将仅支持 KiCad 版本6。要继续将 Ki-nTree 与 KiCad 版本5一起使用，请使用旧0.4.x版本 ( pip install kintree==0.4.8)。

Ki-nTree 由@eeintech为SPARK Microsystems开发，后者慷慨地接受了开源！

开始使用

要求

• Ki-nTree 目前针对 Python 3.8 到 3.10 版本进行了测试。
• Ki-nTree 需要一个 Digi-Key生产API 实例。要创建一个，请访问https://developer.digikey.com/。创建帐户、组织并向您的组织添加生产API。保存客户端 ID 和密钥。

这是一个视频，可帮助您完成不同的步骤

• Ki-nTree 需要 Mouser Search API 密钥。如需申请，请前往https://www.mouser.ca/api-search/并点击“注册搜索 API”

安装（系统范围）

1. 使用 Pip 安装

$ pip install -U kintree

2. 运行 Ki-nTree

$ kintree

在虚拟环境中运行（包含）

Linux / MacOS

创建一个虚拟环境并通过以下方式激活它：

$ python3 -m venv env-kintree
$ source env-kintree/bin/activate

然后按照安装部分的步骤进行操作。

视窗

在 Git Bash 中，使用以下命令创建和激活虚拟环境：

$ python3 -m venv env-kintree
$ source env-kintree/Scripts/activate

对于任何其他 Windows 终端，请参阅官方文档

套餐

Arch Linux

Ki-nTree在 Arch Linux 的 AUR 上以python-kintree.

使用说明

在开始之前

如果您打算将 Ki-nTree 与 InvenTree 一起使用，此工具提供了一个简单的脚本来设置 InvenTree 类别树，您可以按如下方式运行：

警告：在运行它之前，请确保您已~/.config/kintree/user/categories.yaml根据自己的喜好在类别设置文件 () 中设置了类别树，否则它将使用默认设置。

$ python3 -m kintree.setup_inventree

如果在开始使用 Ki-nTree 之前未设置 InvenTree 类别树，您将无法将部件添加到 InvenTree。

发明树权限

每个 InventTree 用户都有一组与其关联的权限。请参阅InvenTree 文档以了解如何设置用户权限。

将部件添加到 InvenTree 所需的最小用户/组权限集是：

• “零件 - 添加”以添加 InventTree 零件
• “采购订单-添加”以添加制造商、供应商及其相关部件

如果您希望在创建 InvenTree 部件时自动添加子类别，则需要启用“部件类别 - 添加”权限。

请注意，每次启用对象的“添加”权限时，InvenTree 也会自动启用该对象的“更改”权限。

设置

1. 打开 Ki-nTree GUI，单击“设置 > Digi-Key”并填写 Digi-Key API 客户端 ID 和密钥（可选：单击“测试”以获取 API 令牌）
2. 点击“设置 > Mouser”并填写 Mouser 零件搜索 API 密钥
3. 单击“设置 > KiCad”，浏览到 KiCad 符号、模板和封装库在您的计算机上存储的位置，然后单击“保存”
4. 如果您打算将此工具与 InvenTree 一起使用，请单击“设置 > InvenTree”并填写您的 InvenTree 服务器地址和凭据，然后单击“保存”（可选：单击“测试”以获取 API 令牌）

获取 Digi-Key API 令牌

显示步骤（点击展开）

输入您的 Digi-Key 开发人员帐户凭据，然后登录。将出现以下页面（user@email.com将显示您的电子邮件地址）：

单击“允许”，将打开另一个页面。
点击“Advanced”按钮，然后点击页面底部的“Proceed to localhost (unsafe)”：

在 Chrome 上，如果没有出现“Proceed to localhost (unsafe)”链接，请启用以下标志：chrome://flags/#allow-insecure-localhost

最后，将打开一个新页面，其中显示“您现在可以关闭此窗口”。消息，继续获取令牌。

零件编号搜索

Ki-nTree 目前支持以下电子供应商的 API：Digi-Key、Mouser 和 LCSC。

1. 在主窗口中，输入零件编号并在下拉列表中选择供应商，然后单击“创建”。它将首先使用供应商的 API 获取零件数据
2. 如果选择了 Digi-Key 并且 API 令牌未找到或过期，则会弹出一个浏览器窗口。要获得新令牌：请按照以下步骤操作
3. 从供应商的 API 成功获取零件数据后，系统将提示您添加/确认/编辑零件信息，然后是Category和Subcategory用于此零件（Ki-nTree 尝试自动匹配它们）
4. 然后，系统将提示您选择 KiCad 符号库、模板和要用于此零件的封装库
5. 在 InvenTree 和/或 KiCad 中完成零件创建需要一些时间，一旦完成，您将收到结果通知
6. 最后，如果零件是在 InvenTree 中创建或找到的，您的浏览器将自动打开一个包含零件信息的新选项卡

享受！

对于您发现的任何问题/错误，请报告问题。

发展

要求

你需要python>=3.8和poetry。

您可以按照其官方网站上的说明、使用pip install poetry或在您的 Linux 发行版上安装软件包来安装诗歌。

设置并运行

1. 克隆此存储库

$ git clone https://github.com/sparkmicro/Ki-nTree

2. 将需求安装到poetry-managed 虚拟环境中

$ poetry install
Installing dependencies from lock file
...
Installing the current project: kintree (0.4.99)

注意：版本不准确（仅占位符）

3. 在虚拟环境中运行 Ki-nTree

$ poetry run python -m kintree_gui

或者

$ poetry shell
$ python -m kintree_gui

建造

1. 确保您遵循了前面的安装步骤，然后运行：

$ poetry build
Building kintree (0.4.99)
  - Building sdist
  - Built kintree-0.4.99.tar.gz
  - Building wheel
  - Built kintree-0.4.99-py3-none-any.whl

2. 退出虚拟环境（Ctrl + D在 Linux 上；您也可以关闭终端并在同一文件夹中重新打开它）。

   pip install dist/<wheel_file>.whl使用上一步中的文件名运行。例如：

pip install dist/kintree-0.4.99-py3-none-any.whl

3. 你现在可以通过kintree在终端中输入来启动 Ki-nTree，前提是你的 python 路径是你的$PATH.

路线图

优先考虑实施新功能而不是改进 GUI
接受新想法和拉取请求：笑脸：

0.5.x 或更高版本

新的功能

• 允许用户决定用于 IPN 的类别代码
• 添加“同步”菜单选项以将 InvenTree 零件数据拉入 KiCad
• 获取 Digi-Key 价格明细并将其添加到供应商部分 (InvenTree)
• 添加选项以作为替代（供应商零件）添加到现有零件
• 文档配置和后端

图形用户界面

• 迁移到 Qt？（见讨论）
• 为 API 搜索创建加载动画 (asyncio)

执照

Ki-nTree 源代码在GPL3.0许可下获得许可，因为它使用该许可下的源代码：

• https://gitlab.com/kicad/libraries/kicad-library-utils
• https://github.com/peeter123/digikey-api

KiCad 模板在知识共享 CC0 1.0 许可下获得许可，这意味着“您可以复制、修改、分发和执行作品，即使用于商业目的，也无需征得许可”（参考）。