beyarkay / eskom-calendar

Get your loadshedding schedule in your calendar and never be left in the dark! Open-source, up-to-date, and developer friendly.
https://eskomcalendar.co.za
GNU General Public License v3.0
190 stars 35 forks source link

[Suggestion] csv of suburb names and their corresponding calendar area names #61

Closed benvalkin closed 1 year ago

benvalkin commented 2 years ago

I think it would be useful to compile a list of suburb names and their corresponding loadshedding area names (as they appear on the calendar list). Something as simple as this: image

This would be good to aid location lookups for each calendar since it's often difficult to know what schedule your suburb belongs to. Plus it would be cool to have a a single open source data file for this information (which is usually displayed on separate municipal websites such as this one)

Compiling such a .csv file would be a once off task and not too tedious. Most suburb block information is posted in PDFs or spreadsheets in some form. image

I'd be happy to manually compile one and put it on this repo if it would be useful (kinda want to do it for myself anyway)

beyarkay commented 2 years ago

Ben and I chatted in person about this. In summary:

Example yaml file:

# Calendar name is the name as seen on the releases page.
- calendar_name: city-of-cape-town-area-15
  province: western-cape
  municipality: city-of-cape-town
  area_name: city-of-cape-town
  block_name: 15
  # Since one calendar can be associated with multiple suburbs, add a 
  # list of possible aliases which the user might want to search for when 
  # looking for this calendar
  aliases: [rosebank, observatory, maitland, salt-river, woodstock, ...]
- calendar_name: city-of-cape-town-area-5
  province: western-cape
  municipality: city-of-cape-town
  area_name: city-of-cape-town
  block_name: 5
  aliases: [newlands, claremont, landsdowne, rondebosch-east, ...]
beyarkay commented 1 year ago

This was fixed by https://github.com/beyarkay/eskom-calendar/commit/28c79e7602964257e72a36d013880f90d043493a