uk_bin_collection 0.136.0__py3-none-any.whl → 0.137.0__py3-none-any.whl

uk_bin_collection/tests/input.json

@@ -832,7 +832,13 @@
         "wiki_name": "Gloucester City Council",
         "wiki_note": "Pass the house number, postcode, and UPRN in their respective parameters. This parser requires a Selenium webdriver."
     },
-    "GraveshamBoroughCouncil": {
+    "GooglePublicCalendarCouncil": {
+        "wiki_name": "Google Calendar (Public)",
+        "url": "https://calendar.google.com/calendar/ical/c_bca6c975545213622b3958bddab567e1e7398709c63e377b6fe9a9140bd1caf8%40group.calendar.google.com/public/basic.ics",
+        "skip_get_url": true,
+        "wiki_note": "The URL should be the public ics file URL for the public Google calendar. See https://support.google.com/calendar/answer/37083?sjid=7202815583021446882-EU. Councils that currently need this are Trafford."
+    },
+        "GraveshamBoroughCouncil": {
         "skip_get_url": true,
         "uprn": "100060927046",
         "url": "https://www.gravesham.gov.uk",

uk_bin_collection/uk_bin_collection/councils/GooglePublicCalendarCouncil.py

@@ -0,0 +1,38 @@
+from datetime import datetime
+from typing import Any
+import requests
+from ics import Calendar
+
+from uk_bin_collection.uk_bin_collection.get_bin_data import AbstractGetBinDataClass
+from uk_bin_collection.uk_bin_collection.common import date_format
+
+
+class CouncilClass(AbstractGetBinDataClass):
+    def parse_data(self, page: str, **kwargs: Any) -> dict:
+        ics_url: str = kwargs.get("url")
+
+        if not ics_url:
+            raise ValueError("Missing required argument: google_calendar_ics_url")
+
+        response = requests.get(ics_url)
+        response.raise_for_status()
+
+        calendar = Calendar(response.text)
+        bindata = {"bins": []}
+
+        for event in calendar.events:
+            if not event.name or not event.begin:
+                continue
+
+            try:
+                # .begin is a datetime-like object (Arrow)
+                collection_date = event.begin.date().strftime(date_format)
+            except Exception:
+                continue
+
+            bindata["bins"].append({
+                "type": event.name,
+                "collectionDate": collection_date
+            })
+
+        return bindata

uk_bin_collection/uk_bin_collection/councils/WalthamForest.py

@@ -73,7 +73,7 @@ class CouncilClass(AbstractGetBinDataClass):
             find_ac_button.send_keys(Keys.RETURN)
             h4_element = wait.until(
                 EC.presence_of_element_located(
-                    (By.XPATH, "//h4[contains(text(), 'Next Collections')]")
+                    (By.XPATH, "//h4[contains(text(), 'Your upcoming collections')]")
                 )
             )
 
@@ -81,7 +81,7 @@ class CouncilClass(AbstractGetBinDataClass):
                 EC.presence_of_element_located(
                     (
                         By.XPATH,
-                        '//div[contains(@class, "fieldContent")]',
+                        '//div[contains(@class, "repeatable-table-wrapper")]',
                     )
                 )
             )
@@ -90,16 +90,15 @@ class CouncilClass(AbstractGetBinDataClass):
 
             data = {"bins": []}
 
-            collection_divs = soup.find_all("div", {"style": "text-align: center;"})
+            collection_divs = soup.find_all("tr", {"class": "repeatable-value"})
 
             for collection_div in collection_divs:
-                h5_tag = collection_div.find("h5")
-                p_tag = collection_div.find("p")
-
-                if h5_tag and p_tag:
-                    bin_type = h5_tag.get_text(strip=True)
-                    collection_date_text = p_tag.find("b").get_text(strip=True)
+                td_list = collection_div.find_all("td")
+                bin_type = td_list[1].get_text(strip=True)
+                collection_date_text = td_list[2].get_text(strip=True)
 
+                # if collection_date_text is not 'NaN'
+                if collection_date_text != "NaN":
                     # Extract and format the date
                     date_match = re.search(r"(\d+ \w+)", collection_date_text)
                     if date_match:

{uk_bin_collection-0.136.0.dist-info → uk_bin_collection-0.137.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uk_bin_collection
-Version: 0.136.0
+Version: 0.137.0
 Summary: Python Lib to collect UK Bin Data
 Author: Robert Bradley
 Author-email: robbrad182@gmail.com
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: bs4
 Requires-Dist: holidays
+Requires-Dist: ics (>=0.7.2,<0.8.0)
 Requires-Dist: lxml
 Requires-Dist: pandas
 Requires-Dist: python-dateutil
@@ -41,10 +42,10 @@ Description-Content-Type: text/markdown
 # 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. 
+Why would you want to do this?
+You might want to use this in 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.**
+**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.
 
@@ -59,12 +60,12 @@ Most scripts make use of [Beautiful Soup 4](https://pypi.org/project/beautifulso
 If an issue already exists, please comment on that issue to express your interest. Please do not open a new issue, as it will be closed as a duplicate.
 
 If an issue does not already exist, 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
+- Name of the council.
+- URL to bin collections.
+- An example postcode and/or [UPRN](https://uprn.uk/) (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 added.
+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 is added to this integration.
 
 ---
 
@@ -80,7 +81,7 @@ This integration can be installed directly via HACS. To install:
 * [Add the repository](https://my.home-assistant.io/redirect/hacs_repository/?owner=robbrad&repository=UKBinCollectionData&category=integration) to your HACS installation
 * Click `Download`
 
-For details how setup the custom component integration see the [this documentation](https://github.com/robbrad/UKBinCollectionData/tree/master/custom_components/uk_bin_collection).
+For details on how to setup the custom component integration, see the [documentation](https://github.com/robbrad/UKBinCollectionData/tree/master/custom_components/uk_bin_collection).
 
 #### Manual
 1. Ensure you have [HACS](https://hacs.xyz/) installed
@@ -90,7 +91,7 @@ For details how setup the custom component integration see the [this documentati
 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).
+1. If you 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 separately such as [standalone-chrome](https://hub.docker.com/r/selenium/standalone-chrome).
 
 ### Install manually
 
@@ -101,15 +102,15 @@ For details how setup the custom component integration see the [this documentati
 1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.
 
 ### Overriding the Bin Icon and Bin Colour
-We realise it is difficult to set a colour from the councils text for the Bin Type and to keep the integration generic we dont capture colour from a council(not all councils supply this as a field), only bin type and next collection date.
+We realise it is difficult to set a colour from the councils text for the Bin Type and to keep the integration generic, we don't capture colour from a council (not all councils supply this as a field), only bin type and next collection date.
 
-When you configure the componenent on the first screen you can set a JSON string to map the bin type to the colour and icon
+When you configure the component on the first screen, you can set a JSON string to map the bin type to the colour and icon
 
 Here is an example to set the colour and icon for the type `Empty Standard General Waste`. This type is the type returned from the council for the bin. You can do this for multiple bins.
 
-If you miss this on the first setup you can reconfigure it.
+If you miss this on the first setup, you can reconfigure it.
 
-```
+```json
 {     
   "Empty Standard General Waste": 
   {         
@@ -147,7 +148,7 @@ where ```council_name``` is the name of the council's .py script (without the .p
 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:
+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
@@ -161,9 +162,8 @@ To check the parameters needed for your council's script, please check the [proj
 
 
 ### 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.
+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.
 
 ---
 
@@ -172,7 +172,7 @@ Some councils make use of the UPRN (Unique property reference number) to identif
 
 ---
 ## Selenium
-Some councils need Selenium to run the scrape on behalf of Home Assistant. The easiest way to do this is run Selenium as in a Docker container. However you do this the Home Assistant server must be able to reach the Selenium server
+Some councils need Selenium to run the scrape on behalf of Home Assistant. The easiest way to do this is run Selenium as in a Docker container. However that you do this, the Home Assistant server must be able to reach the Selenium server.
 
 ### Instructions for Windows, Linux, and Mac
 
@@ -182,7 +182,7 @@ Some councils need Selenium to run the scrape on behalf of Home Assistant. The e
 
 1.  **Download Docker Desktop for Windows:**
     
-    *   Go to the Docker website: Docker Desktop for Windows
+    *   Go to the Docker website: Docker Desktop for Windows.
     *   Download and install Docker Desktop.
 2.  **Run Docker Desktop:**
     
@@ -235,7 +235,7 @@ Some councils need Selenium to run the scrape on behalf of Home Assistant. The e
 
 1.  **Download Docker Desktop for Mac:**
     
-    *   Go to the Docker website: Docker Desktop for Mac
+    *   Go to the Docker website: Docker Desktop for Mac.
     *   Download and install Docker Desktop.
 2.  **Run Docker Desktop:**
     
@@ -253,7 +253,7 @@ Some councils need Selenium to run the scrape on behalf of Home Assistant. The e
     docker pull selenium/standalone-chrome
     ```
     
-4.  **Run the Selenium Standalone Chrome container:**
+3.  **Run the Selenium Standalone Chrome container:**
         
     ```bash
     docker run -d -p 4444:4444 --name selenium-chrome selenium/standalone-chrome
@@ -262,17 +262,17 @@ Some councils need Selenium to run the scrape on behalf of Home Assistant. The e
 #### Step 3: Test the Selenium Server
 
 1.  **Navigate to the Selenium server URL in your web browser:**
-    *   Open a web browser and go to `http://localhost:4444`
+    *   Open a web browser and go to `http://localhost:4444`.
     *   You should see the Selenium Grid console.
 
 #### Step 4: Supply the Selenium Server URL to UKBinCollectionData
 
 1.  **Find the `UKBinCollectionData` project:**
     
-    *   Go to the GitHub repository: [UKBinCollectionData](https://github.com/robbrad/UKBinCollectionData)
+    *   Go to the GitHub repository: [UKBinCollectionData](https://github.com/robbrad/UKBinCollectionData).
 2.  **Supply the Selenium Server URL:**
     
-    *   Typically, the URL will be `http://localhost:4444/wd/hub`
+    *   Typically, the URL will be `http://localhost:4444/wd/hub`.
     *   You might need to update a configuration file or environment variable in the project to use this URL. Check the project's documentation for specific instructions.
 
 ### Summary of Commands
@@ -297,7 +297,7 @@ This guide is based on a Raspberry Pi 4. Instructions for other systems may vary
 
 #### Prerequisites
 1. Install **Portainer** from Alex Belgium's add-on repository:
-   [github.com/alexbelgium/hassio-addons](https://github.com/alexbelgium/hassio-addons)
+   [alexbelgium/hassio-addons](https://github.com/alexbelgium/hassio-addons)
 
 ---
 
@@ -367,13 +367,13 @@ We have created an API for this located under [uk_bin_collection_api_server](htt
 
 ### Prerequisites
 
-- Docker installed on your machine
-- Python (if you plan to run the API locally without Docker)
+- 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.
+2. Navigate to the `uk_bin_collection_api_server` directory of the project.
 
 #### Build the Docker Container
 
@@ -401,7 +401,7 @@ The API documentation can be accessed via the Swagger UI. Use the Swagger UI to
 #### API Endpoints
 `GET /bin_collection/{council}`
 
-Description: Retrieves information about bin collection for the specified council.
+Description: Retrieves information about bin collections for the specified council.
 
 Parameters:
 
@@ -415,9 +415,9 @@ curl -X GET "http://localhost:8080/api/bin_collection/{council}" -H "accept: app
 ```
 
 ## Docker Compose
-This includes the Selenium standalone-chrome for Selenium based councils
+This includes the Selenium standalone-chrome for Selenium-based councils.
 
-```
+```yaml
 version: '3'
 
 services:
@@ -447,8 +447,8 @@ 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'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).
@@ -461,4 +461,3 @@ Contributions are always welcome! See ```CONTRIBUTING.md``` to get started. Plea
   <img src="https://contrib.rocks/image?repo=robbrad/UKBinCollectionData"  alt="Image of contributors"/>
 </a>
 
-

{uk_bin_collection-0.136.0.dist-info → uk_bin_collection-0.137.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ uk_bin_collection/tests/check_selenium_url_in_input.json.py,sha256=Iecdja0I3XIiY
 uk_bin_collection/tests/council_feature_input_parity.py,sha256=DO6Mk4ImYgM5ZCZ-cutwz5RoYYWZRLYx2tr6zIs_9Rc,3843
 uk_bin_collection/tests/features/environment.py,sha256=VQZjJdJI_kZn08M0j5cUgvKT4k3iTw8icJge1DGOkoA,127
 uk_bin_collection/tests/features/validate_council_outputs.feature,sha256=SJK-Vc737hrf03tssxxbeg_JIvAH-ddB8f6gU1LTbuQ,251
-uk_bin_collection/tests/input.json,sha256=69WL-6I_ph_YEnTj_EUbV5KYJI6S1x4_KwcGN3foYjQ,116985
+uk_bin_collection/tests/input.json,sha256=z7WZPptXZTQ49n322hbxD5wa6lpCz4y0WC0cCCkGsHQ,117511
 uk_bin_collection/tests/output.schema,sha256=ZwKQBwYyTDEM4G2hJwfLUVM-5v1vKRvRK9W9SS1sd18,1086
 uk_bin_collection/tests/step_defs/step_helpers/file_handler.py,sha256=Ygzi4V0S1MIHqbdstUlIqtRIwnynvhu4UtpweJ6-5N8,1474
 uk_bin_collection/tests/step_defs/test_validate_council.py,sha256=VZ0a81sioJULD7syAYHjvK_-nT_Rd36tUyzPetSA0gk,3475
@@ -125,6 +125,7 @@ uk_bin_collection/uk_bin_collection/councils/GatesheadCouncil.py,sha256=SRCgYhYs
 uk_bin_collection/uk_bin_collection/councils/GedlingBoroughCouncil.py,sha256=XzfFMCwclh9zAJgsbaj4jywjdiH0wPaFicaVsLrN3ms,2297
 uk_bin_collection/uk_bin_collection/councils/GlasgowCityCouncil.py,sha256=9Rk9KfcglJvRhh4373OfRX-fwywE2xgwx5KejqzV5fE,3399
 uk_bin_collection/uk_bin_collection/councils/GloucesterCityCouncil.py,sha256=iMIlZMoBE4TG-ygw89zynvu-TlC4bWJ7g0vNH92JzHs,4890
+uk_bin_collection/uk_bin_collection/councils/GooglePublicCalendarCouncil.py,sha256=DsheXk3sooWWKctIY3PbHI88HI7GfdgZ7qS-iSVCKYA,1140
 uk_bin_collection/uk_bin_collection/councils/GraveshamBoroughCouncil.py,sha256=ueQ9xFiTxMUBTGV9VjtySHA1EFWliTM0AeNePBIG9ho,4568
 uk_bin_collection/uk_bin_collection/councils/GuildfordCouncil.py,sha256=9pVrmQhZcK2AD8gX8mNvP--L4L9KaY6L3B822VX6fec,5695
 uk_bin_collection/uk_bin_collection/councils/GwyneddCouncil.py,sha256=eK2KkY1NbIxVtBruQYSNPA0J7fuzMik5it02dFbKYV0,1855
@@ -285,7 +286,7 @@ uk_bin_collection/uk_bin_collection/councils/ValeofGlamorganCouncil.py,sha256=dz
 uk_bin_collection/uk_bin_collection/councils/ValeofWhiteHorseCouncil.py,sha256=fyskrQ4-osGOeCZuB_8m2TpW8iwHr7lpl52nrR06Xpo,4441
 uk_bin_collection/uk_bin_collection/councils/WakefieldCityCouncil.py,sha256=mdAXKcoSSF-xnXS8boesFftS8RiKyuR76ITHQ9Q5DgM,4916
 uk_bin_collection/uk_bin_collection/councils/WalsallCouncil.py,sha256=wv-M3zZj0E6EIPoVB9AF_NCg_8XGM9uhqGa-F5yzoc4,2277
-uk_bin_collection/uk_bin_collection/councils/WalthamForest.py,sha256=_0ucZrZx-x49wxV7DGZsj4zcKv25HT-o2PkPabw8r68,4997
+uk_bin_collection/uk_bin_collection/councils/WalthamForest.py,sha256=mN-USLAG5bKQcEDAhuVjA-kDLkFWlE8OAwDOUjHdc3g,5028
 uk_bin_collection/uk_bin_collection/councils/WandsworthCouncil.py,sha256=aQoJpC7YkhKewQyZlsv5m4__2IPoKRsOrPxjNH5xRNo,2594
 uk_bin_collection/uk_bin_collection/councils/WarringtonBoroughCouncil.py,sha256=AB9mrV1v4pKKhfsBS8MpjO8XXBifqojSk53J9Q74Guk,1583
 uk_bin_collection/uk_bin_collection/councils/WarwickDistrictCouncil.py,sha256=DAL_f0BcIxFj7Ngkms5Q80kgSGp9y5zB35wRPudayz8,1644
@@ -318,8 +319,8 @@ uk_bin_collection/uk_bin_collection/councils/YorkCouncil.py,sha256=I2kBYMlsD4bId
 uk_bin_collection/uk_bin_collection/councils/council_class_template/councilclasstemplate.py,sha256=EQWRhZ2pEejlvm0fPyOTsOHKvUZmPnxEYO_OWRGKTjs,1158
 uk_bin_collection/uk_bin_collection/create_new_council.py,sha256=m-IhmWmeWQlFsTZC4OxuFvtw5ZtB8EAJHxJTH4O59lQ,1536
 uk_bin_collection/uk_bin_collection/get_bin_data.py,sha256=YvmHfZqanwrJ8ToGch34x-L-7yPe31nB_x77_Mgl_vo,4545
-uk_bin_collection-0.136.0.dist-info/LICENSE,sha256=vABBUOzcrgfaTKpzeo-si9YVEun6juDkndqA8RKdKGs,1071
-uk_bin_collection-0.136.0.dist-info/METADATA,sha256=Wdp-bbINnFzO7xjPeuqCosmBRSOMFn_KaE5pYz-TOvc,19741
-uk_bin_collection-0.136.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-uk_bin_collection-0.136.0.dist-info/entry_points.txt,sha256=36WCSGMWSc916S3Hi1ZkazzDKHaJ6CD-4fCEFm5MIao,90
-uk_bin_collection-0.136.0.dist-info/RECORD,,
+uk_bin_collection-0.137.0.dist-info/LICENSE,sha256=vABBUOzcrgfaTKpzeo-si9YVEun6juDkndqA8RKdKGs,1071
+uk_bin_collection-0.137.0.dist-info/METADATA,sha256=_mc1mfVauQD8RLPBsVM1F9aYNhddWsEzYC-KRiQhZkE,19851
+uk_bin_collection-0.137.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+uk_bin_collection-0.137.0.dist-info/entry_points.txt,sha256=36WCSGMWSc916S3Hi1ZkazzDKHaJ6CD-4fCEFm5MIao,90
+uk_bin_collection-0.137.0.dist-info/RECORD,,