Metadata-Version: 2.4
Name: deadlink
Version: 0.6.0a5
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Summary: Check and fix URLs in files
Keywords: cli,rust
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

<p align="center">
  <a href="https://github.com/mondaytech-dev/deadlink"><img alt="deadlink" src="https://mondaytech-dev.github.io/deadlink/deadlink-logo-with-text.svg" width="60%"></a>
</p>

[![PyPi Version](https://img.shields.io/pypi/v/deadlink.svg?style=flat-square)](https://pypi.org/project/deadlink/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/deadlink.svg?style=flat-square)](https://pypi.org/project/deadlink/)
[![GitHub stars](https://img.shields.io/github/stars/mondaytech-dev/deadlink.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/mondaytech-dev/deadlink/)
[![Downloads](https://static.pepy.tech/badge/deadlink/month?style=flat-square)](https://pepy.tech/projects/deadlink)

Parses text files for HTTP URLs and checks if they are still valid. Install with

```
pip install deadlink
```

and use as

```sh
deadlink check README.md   # or multiple files/directories
# or deadlink c README.md
```

To explicitly allow or ignore certain URLs, use

```
deadlink check README.md -a http: -i stackoverflow.com github
```

This only considers URLs containing `http:` and _not_ containing `stackoverflow.com` or
`github`. You can also place allow and ignore lists in the config file
`~/.config/deadlink/deadlink.toml`, e.g.,

```toml
timeout_s = 10
cache_ttl_s = 259200
num_concurrent_requests = 5
# allow_file_extensions = ["txt", "yaml", "c"]
ignore_hosts = ["www.example.com"]
```

Example output:

<!--screenshot created with https://carbon.now.sh/-->

![](https://mondaytech-dev.github.io/deadlink/example-output-carbon.png)

