nschloe / deadlink Goto Github PK

View Code? Open in Web Editor NEW

152.0 152.0 3.0 1.77 MB

:skull: Checks and fixes URLs in code and documentation.

License: MIT License

Python 100.00%

command-line python tool url

deadlink's Introduction

Nico from Berlin, math nerd and top-tier software engineer.

You can sponsor my open-source work at GitHub Sponsors. You'll also find information on consulting/code-for-hire there.

Languages

Popular projects

📐 math: quadpy. orthopy, accupy, pacopy, pyfvm
🕸 meshing: meshio, pygmsh, pygalmesh, optimesh, meshzoo, dmsh, meshplex
🚀 performance: perfplot, tuna
🎨 plotting: tikzplotlib, dufte, termplotlib, colorio, cplot, matplotx
💻 xhub, stackoverflow-card, tiptop

Stats

Find me

deadlink's People

Contributors

Stargazers

Watchers

Forkers

aerickson korallin apustar

deadlink's Issues

Links with parens

Common in Wikipedia links.

Example: From https://en.wikipedia.org/wiki/Join_(SQL) link is recognized as https://en.wikipedia.org/wiki/Join_.

how to use this package without the cli, inside a python script ?

Hello, I would like to use this package inside a script. But I cannot find any example. Could you add one exmaple on the home page ?

best

Make `deadlink` available as a pre-commit-hook

Would you consider making deadlink available as a pre-commit hook ?

I'm down to open a PR if you're willing to review it.

As reference: tcort/markdown-link-check#169

Support for umlauts

Hi,

I just found your nice deadlink tool. It works quite well--but not for URLs with umlauts.

If call deadlink with: deadlink check links.txt

where the links.txt content is:

https://wiki.ubuntuusers.de/Shell/Befehlsübersicht

the output is as follows:

Found 1 unique URL in 1 file (ignored 0 files, 0 URLs)
Checking... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01

Failing permanent redirects (1):
   301:   https://wiki.ubuntuusers.de/Shell/Befehls
   → 404: https://wiki.ubuntuusers.de/Shell/Befehls/

It seems that deadlink stops at the umlaut "ü". Is it possible to allow umlauts in URLs?

Feature Request: possible to add filenames?

I like this project!

I'd like to use it as a CI step for my calmcode project, but since that project contains hundreds of pages that it needs to check I was wondering if it's possible to add a flag such that your tool could also tell me what file the link was found in. I'll gladly hear it though if this is out of scope.

Call with no arguments errors

It could be more graceful, either printing the help or doing nothing.

Currently get:

...
... deadlink\_cli.py", line 53, in cli
    return args.func(args)
AttributeError: 'Namespace' object has no attribute 'func'

v0.4.7

argument parsing issues

argparse struggles to determine if README.md is an additional ignore pattern or a path... maybe -i should be comma-separated or you have to specify multiple -i arguments?

Example:

➜  test_repo git:(main)  wurl-check -i excluded_domains README.md
usage: wurl-check [-h] [-t TIMEOUT] [-c MAX_CONNECTIONS] [-k MAX_KEEPALIVE_CONNECTIONS]
                  [-i IGNORE [IGNORE ...]] [-a ALLOW [ALLOW ...]] [--version]
                  paths [paths ...]
wurl-check: error: the following arguments are required: paths

wurl-check README.md bad.txt repositories.json test.py -i excluded_domain yahoo.com detects yahoo.com as an additional file I think (the output only mentions one ignored).