Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Commit

Permalink
minor readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
phette23 committed Jun 12, 2023
1 parent abb30b4 commit 0147b73
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@

Takes a public Koha report and checks each URL (`856$u`) to see if they resolve successfully.

## Setup
## Setup & Usage

Uses poetry, Python 3, and requests. To get started: `poetry install && poetry shell`
Uses poetry, Python 3, and requests. To get start ensure you have [Homebrew](https://brew.sh) then:

Usage: `python linkcheck.py`
```sh
# if you don't have python3 & poetry already
brew install python3 poetry
# create & enter project virtualenv
poetry install
poetry shell
# run it
python linkcheck.py
```

Logs output to console and a CSV file.

Expand All @@ -18,6 +26,6 @@ The app prints URLs with non-200 HTTP response statuses. It also catches HTTP ex

Some websites have poor server hygiene and send successful HTTP responses with non-200 error codes. Not a lot we can do about that.

# LICENSE
## LICENSE

[ECL Version 2.0](https://opensource.org/licenses/ECL-2.0)

0 comments on commit 0147b73

Please sign in to comment.