Waste Collection Schedule

This project automates the process of fetching and displaying upcoming waste collection dates for different types of waste. It uses data from a local waste management API to maintain an up-to-date schedule in both markdown and HTML formats.

Features

• Fetches waste collection data from a local API
• Generates an up-to-date markdown file with upcoming collection dates
• Creates a clean, responsive HTML page
• Runs daily via GitHub Actions to ensure the schedule is always current

Setup

To set up this project locally:

1. Clone the repository:

   git clone https://github.com/your-username/waste-collection-schedule.git
   cd waste-collection-schedule
   

2. Install uv (if not already installed):

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. Set up the Python environment:

   uv sync --all-extras --dev
   

4. Run the script:

   python when.py
   

This will fetch the latest data and update both the waste_table.md and waste_table.html files.

Usage

After setup, the script will:

• Fetch the latest waste collection data
• Update the waste_table.md file with the next collection dates for each waste type
• Generate a responsive HTML page in waste_table.html

To view the upcoming waste collection dates, you can:

• Check the Waste Collection Schedule file
• Open waste_table.html in a web browser

Automated Updates

This project uses GitHub Actions to run the script daily, ensuring that the waste collection schedule is always up-to-date. The workflow file can be found in .github/workflows/update_waste_schedule.yml.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open source and available under the MIT License.