Metadata-Version: 2.1
Name: discolinks
Version: 0.1.3
Summary: Command-line tool which checks a website for broken links.
License: MIT
Keywords: crawler,http,html,link,url,web
Author: Bertrand Bonnefoy-Claudet
Author-email: bertrand@bertrandbc.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Dist: attrs (>=21.4.0,<22.0.0)
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: httpx (>=0.23.0,<0.24.0)
Requires-Dist: rich (>=12.4.4,<13.0.0)
Description-Content-Type: text/markdown

# discolinks

[![Build Status][build_status_badge]][build_status_link]

Discolinks looks for broken links on a website.

Features:

- Starts on one page and recursively finds the other reachable pages on the website.
- Asynchronous: Maximum number of parallel requests is configurable.
- JSON output available: Useful for testing and scripting.

## Getting Started

```bash
$ discolinks --url https://example.net
📂 Results: 13 links (10 ok, 3 failed)
├── 📄 https://example.net/foo
│   ├── 🔗 /bad_absolute_href: 302 → 404
│   └── 🔗 bad_relative_href: 404
└── 📄 https://example.net/bar
    └── 🔗 https://example.org/bad_external_href: Connection error
```

## Development

```bash
... # Activate virtualenv.
poetry install
make check
```

## Release

- Create a branch with a name like `release-1.2.3`.
- Update version in `src/discolinks/__version__.py`.
- Update version in `pyproject.toml`.
- Update changelog.
- Open a pull request and get it merged.
- Tag the release `git tag --message 'Version 1.2.3' 1.2.3`
- Push tags: `git push --tags`

[build_status_badge]: https://github.com/bbc2/discolinks/actions/workflows/main.yml/badge.svg
[build_status_link]: https://github.com/bbc2/discolinks/actions/workflows/main.yml

