Skip to content

Commit

Permalink
getting ready for 2.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-mccarthy committed Dec 22, 2024
1 parent 41c50de commit af20f71
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,26 @@ This script can be run two ways either as a stand alone script that's scheduled

### Running as a GitHub Action

There is a workflow within this repository [check-binday.yaml](.github/workflows/check-binday.yml) which is scheduled for early morning each day to check for bin collections. This workflow requires two secrets, firsly the [UPRN](https://www.findmyaddress.co.uk/search) to be checked for, and the [ntfy.sh](https://ntfy.sh/) topic to publish the message to. Then you'll start recieving notifications when you'll need to put bins out and which bin it is.
There is a workflow within this repository [check-binday.yaml](https://github.com/joe-mccarthy/harlow-bindicator/blob/main/.github/workflows/check-binday.yml) which is scheduled for early morning each day to check for bin collections. This workflow requires two secrets, firsly the [UPRN](https://www.findmyaddress.co.uk/search) to be checked for, and the [ntfy.sh](https://ntfy.sh/) topic to publish the message to. Then you'll start recieving notifications when you'll need to put bins out and which bin it is.

### Running locally

The set up is very similar to how it's run on GitHub actions, with the requirement of a uprn and a ntfy.sh topic. Running the script is as simple as
The script requires additional tools to run, in order to load the webpage that provides the bin information from Harlow Local Authority which is the chromium-chromedriver, just run the command below.

```bash
python src/main.py --uprn "12379870" --topic "topic-name"
sudo apt-get install chromium-chromedriver
```

However before running the script be sure to installe the requirements for python with
Install Harlow Bindicator

```
pip install -r requirements
pip install harlow-bindicator
```

The script also requires additional tools to run, in order to load the webpage that provides the bin information from Harlow Local Authority which is the chromium-chromedriver, just run the command below.
The set up is very similar to how it's run on GitHub actions, with the requirement of a uprn and a ntfy.sh topic. Running the script is as simple as

```bash
sudo apt-get install chromium-chromedriver
harlow-bindicator--uprn "12379870" --topic "topic-name"
```

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "harlow-bindicator"
version = "2.2.1"
version = "2.2.2"
description = "Send alert the day before and on the day of bin collection in Harlow"
authors = ["Joe McCarthy <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit af20f71

Please sign in to comment.