From e9dafb764088eee3ecc29d64b2ea2806ca47e448 Mon Sep 17 00:00:00 2001 From: phette23 Date: Thu, 20 Jul 2023 08:07:00 -0700 Subject: [PATCH] readme update no longer using requests, using httpx --- readme.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index ff460c3..b5bbc2c 100644 --- a/readme.md +++ b/readme.md @@ -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. @@ -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