-
-
Notifications
You must be signed in to change notification settings - Fork 734
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Source: Scenic Rim, QLD, AU (#3267)
* scenic rim initial commit * tidy-up * .md added * gui help added * tidy-up * tidy-up * update_docu_links * duplicate url removed * date consts moved to fetch
- Loading branch information
Showing
8 changed files
with
223 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
...onents/waste_collection_schedule/waste_collection_schedule/source/scenicrim_qld_gov_au.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| import csv | ||
| import logging | ||
| from datetime import datetime, timedelta | ||
|
|
||
| import requests | ||
| from dateutil.rrule import FR, MO, TH, TU, WE, WEEKLY, rrule | ||
| from waste_collection_schedule import Collection # type: ignore[attr-defined] | ||
|
|
||
| TITLE = "Scenic Rim Regional Council" | ||
| DESCRIPTION = "Source for scenicrim.qld.gov.au services for Scenic Rim Regional Council" | ||
| URL = "https://scenicrim.qld.gov.au" | ||
| TEST_CASES = { | ||
| "Red Week": { | ||
| "address": "The Old Avocado Farm 77A Long Road TAMBORINE MOUNTAIN QLD 4272", | ||
| }, | ||
| "Blue Week": { | ||
| "address": "Elysian Fields 2/3043 Beaudesert-Nerang Road WONGLEPONG QLD 4275" | ||
| }, | ||
| } | ||
| API_URL = "https://srrcwastebinserviceday.blob.core.windows.net/wastebinservicedayexport/WasteBinServiceDay_SRRCWebsiteSearch.csv" | ||
| ICON_MAP = { | ||
| "GENERAL WASTE": "mdi:trash-can", | ||
| "RECYCLING": "mdi:recycle", | ||
| } | ||
| DAYS: dict = { | ||
| "MONDAY": MO, | ||
| "TUESDAY": TU, | ||
| "WEDNESDAY": WE, | ||
| "THURSDAY": TH, | ||
| "FRIDAY": FR, | ||
| } | ||
| WEEKDAYS: list = [MO, TU, WE, TH, FR] | ||
| START_DATES: dict = { # taken from https://www.scenicrim.qld.gov.au/downloads/file/6551/your-waste-bins-and-facilities-guide | ||
| "BLUE": datetime(2024, 12, 2, 0, 0, 0), # known Monday in a Red Week | ||
| "RED": datetime(2024, 12, 9, 0, 0, 0), # known Monday in a Blue Week | ||
| } | ||
|
|
||
| # ### Arguments affecting the configuration GUI #### | ||
|
|
||
| HOW_TO_GET_ARGUMENTS_DESCRIPTION = { # Optional dictionary to describe how to get the arguments, will be shown in the GUI configuration form above the input fields, does not need to be translated in all languages | ||
| "en": "Your address as it appears in the _Street_Address_ column of the csv file used by the website. Addresses contain both single-space and double-space character sequences and these need to be preserved. The csv file can be found at (https://srrcwastebinserviceday.blob.core.windows.net/wastebinservicedayexport/WasteBinServiceDay_SRRCWebsiteSearch.csv ", | ||
| } | ||
|
|
||
| PARAM_DESCRIPTIONS = { # Optional dict to describe the arguments, will be shown in the GUI configuration below the respective input field | ||
| "en": { | ||
| "address": "Your address as it appears in the csf file used by the website", | ||
| }, | ||
| } | ||
|
|
||
| PARAM_TRANSLATIONS = { # Optional dict to translate the arguments, will be shown in the GUI configuration form as placeholder text | ||
| "en": { | ||
| "address": "Your address as it appears in the csf file used by the website", | ||
| }, | ||
| } | ||
|
|
||
| # ### End of arguments affecting the configuration GUI #### | ||
|
|
||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class Source: | ||
| def __init__(self, address: str): | ||
| self._address: str = address.upper() | ||
|
|
||
| def generate_dates( | ||
| self, weekday: int, date_start: datetime, interval: int, date_end: datetime | ||
| ) -> list: | ||
| rr = rrule( | ||
| freq=WEEKLY, | ||
| interval=interval, | ||
| wkst=MO, | ||
| byweekday=(weekday), | ||
| dtstart=date_start, | ||
| ) | ||
| dates = [dt for dt in rr.between(date_start, date_end, inc=True)] | ||
| return dates | ||
|
|
||
| def fetch(self): | ||
| s = requests.Session() | ||
|
|
||
| # get master schedule from website | ||
| csv_file = s.get(API_URL) | ||
| csv_decoded = csv_file.content.decode("utf-8") | ||
| address_list: list = csv.reader(csv_decoded.splitlines(), delimiter=",") | ||
| address_list = [ | ||
| [element.upper() for element in address] for address in address_list | ||
| ] | ||
|
|
||
| # extract service day and recycling code | ||
| for item in address_list: | ||
| if self._address in item[0]: | ||
| service_day: str = item[-2] | ||
| recycling_code: str = item[-1].split(" ")[1] | ||
|
|
||
| # set up start/end dates for generate_dates | ||
| now: datetime = datetime.now() | ||
| start_date: datetime = now + timedelta(days=-1) | ||
| end_date: datetime = now + timedelta(days=14) | ||
| # generate general waste dates | ||
| service_days = self.generate_dates(DAYS[service_day], start_date, 1, end_date) | ||
| service_days = [["GENERAL WASTE", day] for day in service_days] | ||
| # generate recycling dates | ||
| recycling_days = self.generate_dates( | ||
| DAYS[service_day], START_DATES[recycling_code], 2, end_date | ||
| ) | ||
| recycling_days = [["RECYCLING", day] for day in recycling_days] | ||
| # combine to create collection schedule | ||
| collection_days: list = service_days + recycling_days | ||
|
|
||
| entries = [] | ||
| for item in collection_days: | ||
| entries.append( | ||
| Collection( | ||
| date=item[1].date(), | ||
| t=item[0], | ||
| icon=ICON_MAP.get(item[0]), | ||
| ) | ||
| ) | ||
|
|
||
| return entries |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Scenic Rim Regional Council | ||
|
|
||
| Support for schedules provided by [Scenic Rim Regional Council](https://scenicrim.qld.gov.au), serving Scenic Rim Regional Council in Queensland, Australia | ||
|
|
||
| ## Configuration via configuration.yaml | ||
|
|
||
| ```yaml | ||
| waste_collection_schedule: | ||
| sources: | ||
| - name: scenicrim_qld_gov_au | ||
| args: | ||
| address: ADDRESS | ||
| ``` | ||
| ### Configuration Variables | ||
| **address** | ||
| *(string) (mandatory)* | ||
| Your address as it appears in the _Street_Address_ column of the | ||
| [csv file](https://srrcwastebinserviceday.blob.core.windows.net/wastebinservicedayexport/WasteBinServiceDay_SRRCWebsiteSearch.csv) used by the website. Addresses contain both single-space and double-space character sequences and these need to be preserved. | ||
| ## Example | ||
| ```yaml | ||
| waste_collection_schedule: | ||
| sources: | ||
| - name: scenicrim_qld_com_au | ||
| args: | ||
| address: "The Old Avocado Farm 77A Long Road TAMBORINE MOUNTAIN QLD 4272" | ||
| ``` |
Oops, something went wrong.