Project aim: a totally unofficial but well-intentioned API to serve data about Katmai National Park's fat bears.
This is one of those "can't sleep at 4am" projects, so it may or may not actually go anywhere.
This project will use Python > 3.8 and Postgres. The rest is TBD.
If you just want to look at the schema, check out the schema.sql file in /database.
You'll need Postgres if you don't already have it
brew install postgres
There is a dumpfile in the /database folder which should contain all you need to start messing around with the data.
Create a database called fat_bear_week and restore the dump.
createdb fat_bear_week
pg_restore -d fat_bear_week -C database.dump
I'm just noodling around at the moment so I'll come back to users and ownership later
Proposed endpoints:
/bears,/bears/{uuid},/bears/{bear_number}- all the ID information held about a bear or bears
/champions- all the winners and their victory year(s)
/matchups/{year}- a simple bear vs. bear list of matchups and dates for the given year
/finalists- all bears who have made it to the final round with no. instances
/rivals- every bear and their no. 1 rival (the bear that has beat them in a 1-1 the most times)
/info/{year}- admin stuff, e.g. no. rounds, participants, start-end dates, winner, no. votes cast
/results/{bracket_uuid}- write a result record for a given bracket uuid.
/bears- create/update a new bear
- Decide on a framework
- Fast API (shiny new thing)
- Flask (I know what I'm doing)
- Django (would be a useful learning experience)
- Actually learn some DevOps so I know how this ends
Outline some useful endpoints