KiCad Rust API

允许您开发与运行实例交互的插件和工具。此库基于官方 KiCad IPC API 构建。

有关 IPC API 的更多信息，请参阅 KiCad 开发者文档。

use kicad::KiCad;

fn main() {
    let k = KiCad::new(KiCadConnectionConfig {
        client_name: String::from("version-example"),
        ..Default::default()
    })
    .expect("KiCad not running!");

    println!("Connected to KiCad {}", k.get_version().unwrap());
}

文档

目前还没有文档，很抱歉。团队的首要任务是完成 KiCad 新 IPC API 的部分，并确保现有 SWIG Python 绑定用户能够平滑过渡。如果您有兴趣为 Rust 绑定做出贡献，请与我们联系！

贡献

目前，这些绑定与 IPC API 本身并行开发，并由 KiCad 团队（主要联系人：Jon Evans / @craftyjon）协调。在此开发期间，请预期会有快速变化和不稳定性，并在事先与团队讨论您的变更想法后，再发送合并请求。

一旦最初的稳定 API 发布（计划于 2025 年 2 月的 KiCad 9.0 中发布），此 Cargo 包也将发布第一个稳定版本，并被视为可供一般使用。在此之前，请将其视为开发预览。

开发

使用 pre-commit 通过 pip 或您首选的方法进行安装。然后运行 pre-commit install 以将预提交钩子添加到您的工作目录。

可以使用简单的 cargo build 构建此库，并且可以使用 cargo 运行示例，例如 cargo run --example version。