Giter VIP home page Giter VIP logo

scambs-bins-api's Introduction

scambs-bins-api

Parser, CLI and REST API proxy server for South Cambridgeshire Council Bins (iCalendar) using Scala, Cats and Http4s

Will parse your public iCal file from https://www.scambs.gov.uk/bins/ and provide a more usable API or run as a command line client.

Primarily made for smart home integration (reminding me to take out the right coloured bin)

Command Line Interface will return a human-readable description or produce no output if tomorrow is not the bin collection day. e.g. The Blue and Green bin will be collected tomorrow

The proxy api returns a chronologically sorted Json array of the following "collection" object:

{
    "date" : {
      "year" : 2020,
      "month" : 3,
      "day" : 20
    },
    "bins" : [
      "GreenBin",
      "BlueBin"
    ]
}

TODO

  • location id hardcoded, fix (param for CLI)
  • cache remote iCal file (Seq[(Date, Seq[Bins])]?) to avoid repeated slow web requests for API

Setup

Usage

  • Automatically run the CLI daily to check if tomorrow is collection day, if CLI outputs text send that to your pushover/google home/whatever

scambs-bins-api's People

Contributors

erlendaakre avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.