帮助验证数据备份/导出的完整性。
spot-check-files的Python项目详细描述
抽查文件
这是一个帮助验证一组文件(例如数据备份/导出)完整性的工具。在
- 检查识别的文件类型是否有错误,例如无效的json。在
- 尽可能生成文件的缩略图。在
- 显示有关文件类型和未识别文件的统计信息。在
它在终端中生成如下报告(在终端中看到图像需要iTerm2):
或as HTML:
使用
安装:
- 安装python3和pip
pip3 install spot_check_files[imgcat]
- imgcat是可选的,支持在osx上的iTerm2中显示缩略图
运行:
spotcheck PATH
这将输出基本统计信息和工具在给定文件/目录中检测到的任何错误。 如果你在Mac上使用iTerm2,它也会显示文件的缩略图。在
或者,可以生成HTML报告:
^{pr2}$可以通过here或运行spotcheck --help
查看完整的选项列表。在
此工具也可以通过编程方式使用。
库的主要入口点是spot_check_files.checker中的CheckerRunner
类。
您可以通过从该模块子类化Checker
类来添加对新文件类型的支持。在
支持的文件类型
命令行工具目前完全依赖于文件扩展名来确定文件类型。在
发展
设置:
- 安装python3和pip
- 克隆回购
- 我建议创建一个venv:
cd spot_check_files python3 -m venv venv source venv/bin/activate
在 - 安装依赖项:
pip install . pip install -r requirements-dev.txt
在
要运行测试:
PYTHONPATH=src pytest
(如图所示重写PYTHONPATH可确保测试针对src/目录中的代码而不是包的已安装副本运行。)
要运行CLI,请执行以下操作:
PYTHONPATH=src python -m spot_check_files ...
贡献
欢迎在GitHub上的https://github.com/brokensandals/spot_check_files上报告错误和请求请求。在
许可证
根据MIT License的条款,这是开源的。在
此软件包包含并使用Monoid字体的副本,该字体也是麻省理工学院授权的。在
- 项目
标签: