svg2mod 项目教程
1. 项目的目录结构及介绍
svg2mod/
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
├── svg2mod/
│ ├── __init__.py
│ ├── cli.py
│ ├── svg.py
│ ├── svg2mod.py
│ └── utils.py
└── tests/
├── __init__.py
├── test_cli.py
├── test_svg.py
└── test_svg2mod.py
- LICENSE: 项目的许可证文件。
- README.md: 项目说明文档。
- requirements.txt: 项目依赖文件。
- setup.py: 项目安装脚本。
- svg2mod/: 项目的主要代码目录。
- init.py: 初始化文件。
- cli.py: 命令行接口文件。
- svg.py: SVG 解析和处理文件。
- svg2mod.py: 主要功能实现文件。
- utils.py: 工具函数文件。
- tests/: 测试代码目录。
- init.py: 初始化文件。
- test_cli.py: 命令行接口测试文件。
- test_svg.py: SVG 解析和处理测试文件。
- test_svg2mod.py: 主要功能测试文件。
2. 项目的启动文件介绍
项目的启动文件是 svg2mod/cli.py
。这个文件定义了命令行接口,用户可以通过命令行运行 svg2mod
命令来使用项目功能。
# svg2mod/cli.py
import argparse
from .svg2mod import convert
def main():
parser = argparse.ArgumentParser(description="Convert Inkscape SVG drawings to KiCad footprint modules")
parser.add_argument("IN_FILENAME", nargs="?", help="Name of the SVG file")
parser.add_argument("-i", "--input-file", dest="FILENAME", help="Name of the SVG file but specified with a flag")
parser.add_argument("-o", "--output-file", dest="FILENAME", help="Name of the output file")
# 其他参数定义...
args = parser.parse_args()
convert(args)
if __name__ == "__main__":
main()
3. 项目的配置文件介绍
项目没有明确的配置文件,但用户可以通过命令行参数来配置项目的行为。以下是一些常用的命令行参数:
-i
,--input-file
: 指定输入的 SVG 文件。-o
,--output-file
: 指定输出的 KiCad 文件。-d
,--dpi
: 设置 DPI(每英寸点数)。-f
,--factor
: 设置缩放因子。-p
,--precision
: 设置精度。--format
: 设置输出格式(legacy 或 pretty)。
例如:
svg2mod -i input.svg -o output.kicad_mod -d 96 -f 1.0 -p 0.01 --format pretty
这个命令将 input.svg
文件转换为 output.kicad_mod
文件,并设置 DPI 为 96,缩放因子为 1.0,精度为 0.01,输出格式为 pretty。