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

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
no longer using requests, using httpx
  • Loading branch information
phette23 committed Jul 20, 2023
1 parent 0fc5cb0 commit e9dafb7
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ Takes a public Koha report and checks each URL (`856$u`) to see if they resolve

## Setup & Usage

Uses poetry, Python 3, and requests. To get start ensure you have [Homebrew](https://brew.sh) then:
Uses poetry, Python 3, and [httpx](https://www.python-httpx.org/). To get start ensure you have [Homebrew](https://brew.sh), copy example.config.py to config.py and enter the values for your environment. To setup the app:

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

Logs output to console and a CSV file.
Expand All @@ -22,9 +21,9 @@ Logs output to console and a CSV file.

Use the included `report.sql` to create a SQL report in Koha, be sure to set "Public" to "Yes" so the report JSON can be publicly accessed.

The app prints URLs with non-200 HTTP response statuses. It also catches HTTP exceptions within the requests library, which can occur when a domain is unavailable.
The app prints URLs with non-200 HTTP response statuses. It also catches HTTP exceptions within httpx, which can occur when a domain is unavailable.

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

## LICENSE

Expand Down

0 comments on commit e9dafb7

Please sign in to comment.