PYURLCHECK

项目目前处于开发中。

pyurlcheck可以用于扫描项目的所有文档并验证任何公开的URL是否仍然可达。

为什么？？？

当在线浏览代码文档时，很明显在文档中跟踪URL并不总是做得很好。遇到不断的404未找到错误会让试图学习如何使用产品或工具的用户感到沮丧。

示例

对单个文件运行工具。

▶ python cli.py examples/example1.md                          
examples/example1.md:8  URL Issue: https://www.ansible.com/jeff

对目录运行工具。目录中的所有文件都将被执行。

▶ python cli.py examples/           
examples/example2.md:6  URL Issue: https://www.ansible.com/jeff
examples/example1.md:8  URL Issue: https://www.ansible.com/fake

或者，

您可以在命令行中将python cli.py替换为pyurlcheck。

▶ pyurlcheck pyurlcheck/examples/
pyurlcheck/examples/example3.txt:4      URL Issue: https://ansible.org.cn/jeff
pyurlcheck/examples/example2.md:7       URL Issue: https://ansible.org.cn/jeff
pyurlcheck/examples/example3.md:3       URL Issue: https://ansible.org.cn/jeff
pyurlcheck/examples/example4.rst:22     URL Issue: http://google.com/france
pyurlcheck/examples/example4.rst:23     URL Issue: http://google.com/japan
pyurlcheck/examples/example1.md:9       URL Issue: https://ansible.org.cn/jeff

当前不检查文件扩展名；因此将验证传入目录中的所有文件。

安装

pip install pyurlcheck