Check links in files
pytest plugin that checks URLs for HTML-containing files.
.md(TODO: select renderer)
pip install pytest-check-links
pytest --check-links mynotebook.ipynb
A comma-separated list of extensions to check
Also check whether links with
#anchors HTML files (either local, or with
html in the
Content-Type) actually exist, and point to exactly one
A regular expression that matches URIs that should not be checked. Can be specified multiple times for multiple ignore patterns. This can be used for files that have a lot of links to GitHub pages, such as a Changelog. GitHub has rate limiting, which would normally cause these files to take up to an hour to complete for larger repositories. For example:
pytest --check-links --check-links-ignore "https://github.com/.*/pull/.*" CHANGELOG.md
Caching requires the installation of
pip install requests-cache
If enabled, each occurance of a link will be checked, no matter how many times it appears in a collection of files to check.
Cache requests when checking links. Caching is disabled by default, and this option must be provided, even if other cache configuration options are provided.
Name of link cache, either the base name of a file or similar, depending on backend.
Cache persistence backend. The other known backends are:
See the requests-cache documentation for more information.
Time to cache link responses (seconds).
Backend-specific options for link cache, provided as
key:value. These are passed
directly to the
requests_cache.CachedSession constructor, as they vary depending
on the backend.
Values will be parsed as JSON first, so to overload the default of caching all
HTTP response codes (which requires a list of
pytest-check-links has adopted automatic code formatting so you shouldn't
need to worry too much about your code style.
As long as your code is valid,
the pre-commit hook should take care of how it should look.
You can invoke the pre-commit hook by hand at any time with:
which should run any autoformatting on your code and tell you about any errors it couldn't fix automatically. You may also install black integration into your text editor to format code automatically.
If you have already committed files before setting up the pre-commit
pre-commit install, you can fix everything up using
pre-commit run --all-files. You need to make the fixing commit
yourself after that.
Some of the hooks only run on CI by default, but you can invoke them by
running with the
--hook-stage manual argument.
- pick a markdown renderer (probably commonmark) or make the markdown renderer pluggable
- options for validating links (allow absolute links, only remote or local, etc.)
- find URLs in Python docstrings
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pytest_check_links-0.8.0-py3-none-any.whl