uk_bin_collection 0.74.0__tar.gz

uk_bin_collection-0.74.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Robert Bradley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uk_bin_collection-0.74.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.1
+Name: uk_bin_collection
+Version: 0.74.0
+Summary: Python Lib to collect UK Bin Data
+Author: Robert Bradley
+Author-email: robbrad182@gmail.com
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: bs4
+Requires-Dist: holidays
+Requires-Dist: lxml
+Requires-Dist: pandas
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: selenium
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: urllib3
+Requires-Dist: webdriver-manager (>=4.0.1,<5.0.0)
+Project-URL: issues, https://github.com/robbrad/UKBinCollectionData/issues
+Description-Content-Type: text/markdown
+
+[![Made with Python](https://img.shields.io/badge/Made%20With%20Python-red?style=for-the-badge&logo=python&logoColor=white&labelColor=red)](https://www.python.org)
+
+[![HACS Badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData)
+[![Current Release](https://img.shields.io/github/v/release/robbrad/UKBinCollectionData?style=for-the-badge&filter=*)](https://github.com/robbrad/UKBinCollectionData/releases)
+[![PyPi](https://img.shields.io/pypi/v/uk_bin_collection?label=PyPI&logo=pypi&style=for-the-badge&color=blue)](https://pypi.org/project/uk-bin-collection/)
+
+[![GitHub license](https://img.shields.io/github/license/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aopen+is%3Aissue)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aclosed)
+[![GitHub contributors](https://img.shields.io/github/contributors/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/graphs/contributors)
+
+[![Test Councils](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/behave.yml?style=for-the-badge&label=Test+Councils)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/behave.yml)
+![Codecov](https://img.shields.io/codecov/c/gh/robbrad/UKBinCollectionData?style=for-the-badge)
+[![CodeQL Analysis](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/codeql-analysis.yml?style=for-the-badge&label=CodeQL+Analysis)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/codeql-analysis.yml)
+[![Publish Release](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/release.yml?style=for-the-badge&label=Publish+Release)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/release.yml)
+[![Test Report Deployment](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/pages%2Fpages-build-deployment?style=for-the-badge&label=Test+Report+Deployment)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/pages/pages-build-deployment)
+
+# UK Bin Collection Data (UKBCD)
+This project aims to provide a neat and standard way of providing bin collection data in JSON format from UK councils that have no API to do so.
+
+Why do this?
+You might want to use this in a Home Automation - for example say you had an LED bar that lit up on the day of bin collection to the colour of the bin you want to take out, then this repo provides the data for that. 
+
+**PLEASE respect a councils infrastructure / usage policy and only collect data for your own personal use on a suitable frequency to your collection schedule.**
+
+Most scripts make use of [Beautiful Soup 4](https://pypi.org/project/beautifulsoup4/) to scrape data, although others use different approaches, such as emulating web browser behaviour, or reading data from CSV files.
+
+[![](https://img.shields.io/badge/-41BDF5?style=for-the-badge&logo=homeassistant&logoColor=white&label=HomeAssistant+Thread)](https://community.home-assistant.io/t/bin-waste-collection/55451)
+[![](https://img.shields.io/badge/Request%20a%20council-gray?style=for-the-badge&logo=github&logoColor=white)](https://github.com/robbrad/UKBinCollectionData/issues/new/choose)
+
+---
+
+## Home Assistant Usage
+
+### Install with HACS (recommended)
+
+1. Ensure you have [HACS](https://hacs.xyz/) installed
+1. In the Home Assistant UI go to `HACS` > `Integrations` > `⋮` > `Custom repositories`.
+1. Enter `https://github.com/robbrad/UKBinCollectionData` in the `Repository` field.
+1. Select `Integration` as the category then click `ADD`.
+1. Click `+ Add Integration` and search for and select `UK Bin Collection Data` then click `Download`.
+1. Restart your Home Assistant.
+1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.
+1. If your see a "URL of the remote Selenium web driver to use" field when setting up your council, you'll need to provide the URL to a web driver you've set up seperately such as [standalone-chrome](https://hub.docker.com/r/selenium/standalone-chrome).
+
+### Install manually
+
+1. Open the folder for your Home Assistant configuration (where you find `configuration.yaml`).
+1. If you do not have a `custom_components` folder there, you need to create it.
+1. [Download](https://github.com/robbrad/UKBinCollectionData/archive/refs/heads/master.zip) this repository then copy the folder `custom_components/uk_bin_collection` into the `custom_components` folder you found/created in the previous step.
+1. Restart your Home Assistant.
+1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.
+
+---
+
+## Standalone Usage
+```commandline
+PS G:\Projects\Python\UKBinCollectionData\uk_bin_collection\collect_data.py
+usage: collect_data.py [-h] [-p POSTCODE] [-n NUMBER] [-u UPRN] module URL
+
+positional arguments:
+  module                Name of council module to use                           (required)
+  URL                   URL to parse                                            (required)
+
+options:
+  -h, --help                            show this help message                  (optional)
+  -p POSTCODE, --postcode POSTCODE      Postcode to parse - should include      (optional)
+                                        a space and be wrapped in double
+                                        quotes                                  
+  -n NUMBER, --number NUMBER            House number to parse                   (optional)
+  -u UPRN, --uprn UPRN                  UPRN to parse                           (optional)
+```
+
+### Quickstart
+The basic command to execute a script is:
+```commandline
+python collect_data.py <council_name> "<collection_url>"
+```
+where ```council_name``` is the name of the council's .py script (without the .py) and ```collection_url``` is the URL to scrape.
+The help documentation refers to these as "module" and "URL", respectively. Supported council scripts can be found in the `uk_bin_collection/uk_bin_collection/councils` folder.
+
+Some scripts require additional parameters, for example, when a UPRN is not passed in a URL, or when the script is not scraping a web page.
+For example, the Leeds City Council script needs two additional parameters - a postcode, and a house number. This is done like so:
+
+```commandline
+python collect_data.py LeedsCityCouncil https://www.leeds.gov.uk/residents/bins-and-recycling/check-your-bin-day -p "LS1 2JG" -n 41
+```
+- A **postcode** can be passed with `-p "postcode"` or `--postcode "postcode"`. The postcode must always include a space in the middle and
+be wrapped in double quotes (due to how command line arguments are handled).
+- A **house number** can be passed with `-n number` or `--number number`.
+- A **UPRN reference** can be passed with `-u uprn` or `--uprn uprn`.
+
+To check the parameters needed for your council's script, please check the [project wiki](https://github.com/robbrad/UKBinCollectionData/wiki) for more information.
+
+
+### Project dependencies
+Some scripts rely on external packages to function. A list of required scripts for both development and execution can be found in the project's [PROJECT_TOML](https://github.com/robbrad/UKBinCollectionData/blob/feature/%2353_integration_tests/pyproject.toml) 
+Install can be done via 
+`poetry install` from within the root of the repo.
+
+---
+
+## UPRN Finder
+Some councils make use of the UPRN (Unique property reference number) to identify your property. You can find yours [here](https://www.findmyaddress.co.uk/search) or [here](https://uprn.uk/).
+
+---
+
+## Requesting your council
+To make a request for your council, first check the [Issues](https://github.com/robbrad/UKBinCollectionData/issues) page to make sure it has not already been requested. If not, please fill in a new [Council Request](https://github.com/robbrad/UKBinCollectionData/issues/new/choose) form, including as much information as possible, including:
+- Name of the council
+- URL to bin collections
+- An example postcode and/or UPRN (whichever is relevant)
+- Any further information
+
+Please be aware that this project is run by volunteer contributors and completion depends on numerous factors - even with a request, we cannot guarantee if/when your council will get a script.
+
+---
+
+## Reports
+
+- [3.11](https://robbrad.github.io/UKBinCollectionData/3.11/)
+- [3.12](https://robbrad.github.io/UKBinCollectionData/3.12/)
+
+---
+## Docker API Server
+We have created an API for this located under [uk_bin_collection_api_server](https://github.com/robbrad/UKBinCollectionData/uk_bin_collection_api_server)
+
+### Prerequisites
+
+- Docker installed on your machine
+- Python (if you plan to run the API locally without Docker)
+
+### Running the API with Docker
+
+1. Clone this repository.
+2. Navigate to the uk_bin_collection_api_server directory of the project.
+
+#### Build the Docker Container
+
+```bash
+docker build -t ukbc_api_server .
+```
+
+```
+docker run -p 8080:8080 ukbc_api_server
+```
+
+#### Accessing the API
+
+Once the Docker container is running, you can access the API endpoints:
+
+    API Base URL: http://localhost:8080/api
+    Swagger UI: http://localhost:8080/api/ui/
+
+#### API Documentation
+
+The API documentation can be accessed via the Swagger UI. Use the Swagger UI to explore available endpoints, test different requests, and understand the API functionalities.
+
+![Swagger UI](SwaggerUI.png)
+
+#### API Endpoints
+`GET /bin_collection/{council}`
+
+Description: Retrieves information about bin collection for the specified council.
+
+Parameters:
+
+    council (required): Name of the council.
+    Other optional parameters: [Specify optional parameters if any]
+
+Example Request:
+
+```bash
+curl -X GET "http://localhost:8080/api/bin_collection/{council}" -H "accept: application/json"
+```
+
+## Docker Compose
+This includes the Selenium standalone-chrome for Selenium based councils
+
+```
+version: '3'
+
+services:
+  ukbc_api_server:
+    build:
+      context: .
+      dockerfile: Dockerfile 
+    ports:
+      - "8080:8080"  # Adjust the ports as needed
+    depends_on:
+      - selenium
+
+  selenium:
+    image: selenium/standalone-chrome:latest
+    ports:
+      - "4444:4444"
+
+```
+### Run with
+```bash
+sudo apt-get update
+sudo apt-get install docker-compose
+
+docker-compose up
+```
+
+---
+
+## FAQ
+#### I've got an issue/support question - what do I do?
+Please post in the [HomeAssistant thread](https://community.home-assistant.io/t/bin-waste-collection/55451) or raise a new (non council request) [issue](https://github.com/robbrad/UKBinCollectionData/issues/new).
+
+#### I'd like to contribute, where do I start?
+Contributions are always welcome! See ```CONTRIBUTING.md``` to get started. Please adhere to the project's [code of conduct](https://github.com/robbrad/UKBinCollectionData/blob/master/CODE_OF_CONDUCT.md).
+
+- If you're new to coding/Python/BeautifulSoup, feel free to check [here](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for issues that are good for newcomers!
+- If you would like to try writing your own scraper, feel free to fork this project and use existing scrapers as a base for your approach (or `councilclasstemplate.py`).
+
+## Contributors
+<a href="https://github.com/robbrad/UKBinCollectionData/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=robbrad/UKBinCollectionData"  alt="Image of contributors"/>
+</a>
+
+

uk_bin_collection-0.74.0/README.md

@@ -0,0 +1,223 @@
+[![Made with Python](https://img.shields.io/badge/Made%20With%20Python-red?style=for-the-badge&logo=python&logoColor=white&labelColor=red)](https://www.python.org)
+
+[![HACS Badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData)
+[![Current Release](https://img.shields.io/github/v/release/robbrad/UKBinCollectionData?style=for-the-badge&filter=*)](https://github.com/robbrad/UKBinCollectionData/releases)
+[![PyPi](https://img.shields.io/pypi/v/uk_bin_collection?label=PyPI&logo=pypi&style=for-the-badge&color=blue)](https://pypi.org/project/uk-bin-collection/)
+
+[![GitHub license](https://img.shields.io/github/license/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aopen+is%3Aissue)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aclosed)
+[![GitHub contributors](https://img.shields.io/github/contributors/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/graphs/contributors)
+
+[![Test Councils](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/behave.yml?style=for-the-badge&label=Test+Councils)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/behave.yml)
+![Codecov](https://img.shields.io/codecov/c/gh/robbrad/UKBinCollectionData?style=for-the-badge)
+[![CodeQL Analysis](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/codeql-analysis.yml?style=for-the-badge&label=CodeQL+Analysis)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/codeql-analysis.yml)
+[![Publish Release](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/release.yml?style=for-the-badge&label=Publish+Release)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/release.yml)
+[![Test Report Deployment](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/pages%2Fpages-build-deployment?style=for-the-badge&label=Test+Report+Deployment)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/pages/pages-build-deployment)
+
+# UK Bin Collection Data (UKBCD)
+This project aims to provide a neat and standard way of providing bin collection data in JSON format from UK councils that have no API to do so.
+
+Why do this?
+You might want to use this in a Home Automation - for example say you had an LED bar that lit up on the day of bin collection to the colour of the bin you want to take out, then this repo provides the data for that. 
+
+**PLEASE respect a councils infrastructure / usage policy and only collect data for your own personal use on a suitable frequency to your collection schedule.**
+
+Most scripts make use of [Beautiful Soup 4](https://pypi.org/project/beautifulsoup4/) to scrape data, although others use different approaches, such as emulating web browser behaviour, or reading data from CSV files.
+
+[![](https://img.shields.io/badge/-41BDF5?style=for-the-badge&logo=homeassistant&logoColor=white&label=HomeAssistant+Thread)](https://community.home-assistant.io/t/bin-waste-collection/55451)
+[![](https://img.shields.io/badge/Request%20a%20council-gray?style=for-the-badge&logo=github&logoColor=white)](https://github.com/robbrad/UKBinCollectionData/issues/new/choose)
+
+---
+
+## Home Assistant Usage
+
+### Install with HACS (recommended)
+
+1. Ensure you have [HACS](https://hacs.xyz/) installed
+1. In the Home Assistant UI go to `HACS` > `Integrations` > `⋮` > `Custom repositories`.
+1. Enter `https://github.com/robbrad/UKBinCollectionData` in the `Repository` field.
+1. Select `Integration` as the category then click `ADD`.
+1. Click `+ Add Integration` and search for and select `UK Bin Collection Data` then click `Download`.
+1. Restart your Home Assistant.
+1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.
+1. If your see a "URL of the remote Selenium web driver to use" field when setting up your council, you'll need to provide the URL to a web driver you've set up seperately such as [standalone-chrome](https://hub.docker.com/r/selenium/standalone-chrome).
+
+### Install manually
+
+1. Open the folder for your Home Assistant configuration (where you find `configuration.yaml`).
+1. If you do not have a `custom_components` folder there, you need to create it.
+1. [Download](https://github.com/robbrad/UKBinCollectionData/archive/refs/heads/master.zip) this repository then copy the folder `custom_components/uk_bin_collection` into the `custom_components` folder you found/created in the previous step.
+1. Restart your Home Assistant.
+1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.
+
+---
+
+## Standalone Usage
+```commandline
+PS G:\Projects\Python\UKBinCollectionData\uk_bin_collection\collect_data.py
+usage: collect_data.py [-h] [-p POSTCODE] [-n NUMBER] [-u UPRN] module URL
+
+positional arguments:
+  module                Name of council module to use                           (required)
+  URL                   URL to parse                                            (required)
+
+options:
+  -h, --help                            show this help message                  (optional)
+  -p POSTCODE, --postcode POSTCODE      Postcode to parse - should include      (optional)
+                                        a space and be wrapped in double
+                                        quotes                                  
+  -n NUMBER, --number NUMBER            House number to parse                   (optional)
+  -u UPRN, --uprn UPRN                  UPRN to parse                           (optional)
+```
+
+### Quickstart
+The basic command to execute a script is:
+```commandline
+python collect_data.py <council_name> "<collection_url>"
+```
+where ```council_name``` is the name of the council's .py script (without the .py) and ```collection_url``` is the URL to scrape.
+The help documentation refers to these as "module" and "URL", respectively. Supported council scripts can be found in the `uk_bin_collection/uk_bin_collection/councils` folder.
+
+Some scripts require additional parameters, for example, when a UPRN is not passed in a URL, or when the script is not scraping a web page.
+For example, the Leeds City Council script needs two additional parameters - a postcode, and a house number. This is done like so:
+
+```commandline
+python collect_data.py LeedsCityCouncil https://www.leeds.gov.uk/residents/bins-and-recycling/check-your-bin-day -p "LS1 2JG" -n 41
+```
+- A **postcode** can be passed with `-p "postcode"` or `--postcode "postcode"`. The postcode must always include a space in the middle and
+be wrapped in double quotes (due to how command line arguments are handled).
+- A **house number** can be passed with `-n number` or `--number number`.
+- A **UPRN reference** can be passed with `-u uprn` or `--uprn uprn`.
+
+To check the parameters needed for your council's script, please check the [project wiki](https://github.com/robbrad/UKBinCollectionData/wiki) for more information.
+
+
+### Project dependencies
+Some scripts rely on external packages to function. A list of required scripts for both development and execution can be found in the project's [PROJECT_TOML](https://github.com/robbrad/UKBinCollectionData/blob/feature/%2353_integration_tests/pyproject.toml) 
+Install can be done via 
+`poetry install` from within the root of the repo.
+
+---
+
+## UPRN Finder
+Some councils make use of the UPRN (Unique property reference number) to identify your property. You can find yours [here](https://www.findmyaddress.co.uk/search) or [here](https://uprn.uk/).
+
+---
+
+## Requesting your council
+To make a request for your council, first check the [Issues](https://github.com/robbrad/UKBinCollectionData/issues) page to make sure it has not already been requested. If not, please fill in a new [Council Request](https://github.com/robbrad/UKBinCollectionData/issues/new/choose) form, including as much information as possible, including:
+- Name of the council
+- URL to bin collections
+- An example postcode and/or UPRN (whichever is relevant)
+- Any further information
+
+Please be aware that this project is run by volunteer contributors and completion depends on numerous factors - even with a request, we cannot guarantee if/when your council will get a script.
+
+---
+
+## Reports
+
+- [3.11](https://robbrad.github.io/UKBinCollectionData/3.11/)
+- [3.12](https://robbrad.github.io/UKBinCollectionData/3.12/)
+
+---
+## Docker API Server
+We have created an API for this located under [uk_bin_collection_api_server](https://github.com/robbrad/UKBinCollectionData/uk_bin_collection_api_server)
+
+### Prerequisites
+
+- Docker installed on your machine
+- Python (if you plan to run the API locally without Docker)
+
+### Running the API with Docker
+
+1. Clone this repository.
+2. Navigate to the uk_bin_collection_api_server directory of the project.
+
+#### Build the Docker Container
+
+```bash
+docker build -t ukbc_api_server .
+```
+
+```
+docker run -p 8080:8080 ukbc_api_server
+```
+
+#### Accessing the API
+
+Once the Docker container is running, you can access the API endpoints:
+
+    API Base URL: http://localhost:8080/api
+    Swagger UI: http://localhost:8080/api/ui/
+
+#### API Documentation
+
+The API documentation can be accessed via the Swagger UI. Use the Swagger UI to explore available endpoints, test different requests, and understand the API functionalities.
+
+![Swagger UI](SwaggerUI.png)
+
+#### API Endpoints
+`GET /bin_collection/{council}`
+
+Description: Retrieves information about bin collection for the specified council.
+
+Parameters:
+
+    council (required): Name of the council.
+    Other optional parameters: [Specify optional parameters if any]
+
+Example Request:
+
+```bash
+curl -X GET "http://localhost:8080/api/bin_collection/{council}" -H "accept: application/json"
+```
+
+## Docker Compose
+This includes the Selenium standalone-chrome for Selenium based councils
+
+```
+version: '3'
+
+services:
+  ukbc_api_server:
+    build:
+      context: .
+      dockerfile: Dockerfile 
+    ports:
+      - "8080:8080"  # Adjust the ports as needed
+    depends_on:
+      - selenium
+
+  selenium:
+    image: selenium/standalone-chrome:latest
+    ports:
+      - "4444:4444"
+
+```
+### Run with
+```bash
+sudo apt-get update
+sudo apt-get install docker-compose
+
+docker-compose up
+```
+
+---
+
+## FAQ
+#### I've got an issue/support question - what do I do?
+Please post in the [HomeAssistant thread](https://community.home-assistant.io/t/bin-waste-collection/55451) or raise a new (non council request) [issue](https://github.com/robbrad/UKBinCollectionData/issues/new).
+
+#### I'd like to contribute, where do I start?
+Contributions are always welcome! See ```CONTRIBUTING.md``` to get started. Please adhere to the project's [code of conduct](https://github.com/robbrad/UKBinCollectionData/blob/master/CODE_OF_CONDUCT.md).
+
+- If you're new to coding/Python/BeautifulSoup, feel free to check [here](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for issues that are good for newcomers!
+- If you would like to try writing your own scraper, feel free to fork this project and use existing scrapers as a base for your approach (or `councilclasstemplate.py`).
+
+## Contributors
+<a href="https://github.com/robbrad/UKBinCollectionData/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=robbrad/UKBinCollectionData"  alt="Image of contributors"/>
+</a>
+

uk_bin_collection-0.74.0/pyproject.toml

@@ -0,0 +1,72 @@
+[tool.poetry]
+name = "uk_bin_collection"
+version = "0.74.0"
+description = "Python Lib to collect UK Bin Data"
+readme = "README.md"
+authors = ["Robert Bradley <robbrad182@gmail.com>"]
+packages = [
+    { include = "uk_bin_collection", from = "." },
+]
+include = ["uk_bin_collection"]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    ".", "uk_bin_collection"
+]
+
+[tool.flit.metadata]
+module = "uk_bin_collection"
+
+[tool.poetry.urls]
+issues = "https://github.com/robbrad/UKBinCollectionData/issues"
+
+[build-system]
+requires = ["poetry-core>=1.2.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.dev-dependencies]
+black = "*"
+coverage = "*"
+flake8 = "*"
+jsonschema = "*"
+pylint = "*"
+pytest = "*"
+setuptools = "*"
+pytest-bdd = "*"
+allure-pytest-bdd = "*"
+pytest-xdist = {extras = ["psutil"], version = "*"}
+pyhamcrest = "*"
+tabulate = "^0.9.0"
+
+[tool.poetry.scripts]
+uk_bin_collection = "uk_bin_collection.uk_bin_collection.collect_data:run"
+
+[tool.dephell.main]
+versioning = "semver"
+from = {format = "poetrylock", path = "poetry.lock"}
+envs = ["main"]
+to = {format = "poetry", path = "pyproject.toml"}
+
+[tool.poetry.dependencies]
+bs4 = "*"
+python-dateutil = "*"
+holidays = "*"
+pandas = "*"
+python = ">=3.11"
+requests = "*"
+selenium = "*"
+lxml = "*"
+urllib3 = "*"
+webdriver-manager = "^4.0.1"
+tabulate = "^0.9.0"
+
+[tool.commitizen]
+major_version_zero = true
+version_provider = "poetry"
+version_scheme = "semver"
+version_files = [
+    "custom_components/uk_bin_collection/manifest.json:version",
+    "custom_components/uk_bin_collection/manifest.json:requirements",
+    "custom_components/uk_bin_collection/config_flow.py:githubusercontent"
+]
+

uk_bin_collection-0.74.0/uk_bin_collection/tests/council_feature_input_parity.py

@@ -0,0 +1,79 @@
+import json
+import re
+import requests
+import sys
+from tabulate import tabulate
+
+def get_councils_from_files(branch):
+    url = f"https://api.github.com/repos/robbrad/UKBinCollectionData/contents/uk_bin_collection/uk_bin_collection/councils?ref={branch}"
+    response = requests.get(url)
+    data = response.json()
+    return [item['name'].replace('.py', '') for item in data if item['name'].endswith('.py')]
+
+def get_councils_from_json(branch):
+    url = f"https://raw.githubusercontent.com/robbrad/UKBinCollectionData/{branch}/uk_bin_collection/tests/input.json"
+    response = requests.get(url)
+    data = json.loads(response.text)
+    return list(data.keys())
+
+def get_councils_from_features(branch):
+    url = f"https://raw.githubusercontent.com/robbrad/UKBinCollectionData/{branch}/uk_bin_collection/tests/features/validate_council_outputs.feature"
+    response = requests.get(url)
+    content = response.text
+    return re.findall(r'Examples:\s+(\w+)', content)
+
+def compare_councils(councils1, councils2, councils3):
+    set1 = set(councils1)
+    set2 = set(councils2)
+    set3 = set(councils3)
+    all_councils = set1 | set2 | set3
+    all_council_data = {}
+    discrepancies_found = False
+    for council in all_councils:
+        in_files = council in set1
+        in_json = council in set2
+        in_features = council in set3
+        discrepancies_count = [in_files, in_json, in_features].count(False)
+        all_council_data[council] = {
+            'in_files': in_files,
+            'in_json': in_json,
+            'in_features': in_features,
+            'discrepancies_count': discrepancies_count
+        }
+        if discrepancies_count > 0:
+            discrepancies_found = True
+    return all_council_data, discrepancies_found
+
+def main(branch="master"):
+    # Execute and print the comparison
+    file_councils = get_councils_from_files(branch)
+    json_councils = get_councils_from_json(branch)
+    feature_councils = get_councils_from_features(branch)
+
+    all_councils_data, discrepancies_found = compare_councils(file_councils, json_councils, feature_councils)
+
+    # Create a list of lists for tabulate, sort by discrepancies count and then by name
+    table_data = []
+    headers = ["Council Name", "In Files", "In JSON", "In Features", "Discrepancies"]
+    for council, presence in sorted(all_councils_data.items(), key=lambda x: (x[1]['discrepancies_count'], x[0])):
+        row = [
+            council,
+            "✔" if presence['in_files'] else "✘",
+            "✔" if presence['in_json'] else "✘",
+            "✔" if presence['in_features'] else "✘",
+            presence['discrepancies_count']
+        ]
+        table_data.append(row)
+
+    # Print the table using tabulate
+    print(tabulate(table_data, headers=headers, tablefmt='grid'))
+
+    if discrepancies_found:
+        print("Discrepancies found! Failing the workflow.")
+        sys.exit(1)
+    else:
+        print("No discrepancies found. Workflow successful.")
+
+if __name__ == "__main__":
+    branch = sys.argv[1] if len(sys.argv) > 1 else "master"
+    main(branch)

uk_bin_collection-0.74.0/uk_bin_collection/tests/features/environment.py

@@ -0,0 +1,7 @@
+from behave import use_step_matcher
+
+use_step_matcher("cfparse")
+
+
+def before_all(context):
+    context.config.setup_logging()