harlow-bindicator 2.2.1

Send alert the day before and on the day of bin collection in Harlow

Harlow Bindicator

Script when run goes the the Harlow Local Authority website collects the bin collection dates for a given UPRN then sends a notification to ntfy.sh if required. This script can either be run locally or as with this repository as a GitHub action.

Running Harlow Bindicator

This script can be run two ways either as a stand alone script that's scheduled using a cron job or as with this Repository a GitHub Action.

Running as a GitHub Action

There is a workflow within this repository check-binday.yaml which is scheduled for early morning each day to check for bin collections. This workflow requires two secrets, firsly the UPRN to be checked for, and the 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

python src/main.py --uprn "12379870" --topic "topic-name"

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

pip install -r requirements

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.

sudo apt-get install chromium-chromedriver

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.