Search docs and validate URLs found are working properly.
Project description
PYURLCHECK
Project is currently a WIP.
pyurlcheck
can be used to scan through all of a projects documents and validate any public
facing URLs are still reachable.
Why??
It's apparent when navigating code documentation online that keeping up with URLs in documentation isn't always done properly. Running into constant 404 Not Found
errors is frustrating for users that are trying to learn how to use a product or tool.
Examples
Running the tool against a single file.
▶ python cli.py examples/example1.md
examples/example1.md:8 URL Issue: https://www.ansible.com/jeff
Running the tool against a directory. All files in the directory will be executed.
▶ 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
Alternatively,
you can replace python cli.py
with pyurlcheck
on the command line.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyurlcheck-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a81aa00274a3e479f12f15a754c9f55f7bae6a77e790ef62e048246dcaa547c9 |
|
MD5 | f20667ee0703237f88ec51a058ce0e77 |
|
BLAKE2b-256 | afb4a0a8d87c2ecf745e7c94a29708f78ff5e00c29d87331fb8b454292f6ed5a |