hotseatio / hotseat.io

The code for Hotseat!
https://hotseat.io
16 stars 2 forks source link

question: public API? #92

Open mizlan opened 1 year ago

mizlan commented 1 year ago

Is there a public API for Hotseat? I specifically would be interested in the class enrollment data. I began work on scraping it myself, mostly successfully, but it seems that would be duplicating efforts that have already been done.

nathanmsmith commented 1 year ago

There is not a public API for Hotseat, but that is something we've been talking about making. @mizlan, what's your planned usage with the enrollment data and would you be interested in contributing to the public API?

mizlan commented 1 year ago

I want to design my own frontend for the calendar-view planner, and I am more generally interested in the decoupling of the enrollment data from any particular interface.

I would be, yes! I also would like to ask: would you be opposed to offering some method of exporting a dump of the current state of the enrollment data?

On Wed, Jun 7, 2023 at 9:04 AM Nathan Smith @.***> wrote:

There is not a public API for Hotseat, but that is something we've been talking about making. @mizlan https://github.com/mizlan, what's your planned usage with the enrollment data and would you be interested in contributing to the public API?

— Reply to this email directly, view it on GitHub https://github.com/hotseatio/hotseat.io/issues/92#issuecomment-1581124197, or unsubscribe https://github.com/notifications/unsubscribe-auth/AKSBU2MU2JJKMBWRXO6DAVLXKCQ7RANCNFSM6AAAAAAY5MOIOM . You are receiving this because you were mentioned.Message ID: @.***>

nathanmsmith commented 1 year ago

would you be opposed to offering some method of exporting a dump of the current state of the enrollment data?

Wouldn't the API do this? I think an API would help smooth over some of the rough edges in our database schema too, so I think I'd prefer that to a dump. Let me know if I'm missing something though.

nathanmsmith commented 1 year ago

fwiw, we've also been thinking about making a Hotseat-ified version of the calendar-view planner – I'm curious about what improvements you're thinking of! Mind if we set up a call? I'd love to learn more and get your thoughts on the API design. I can help get your env set up for Hotseat too!

mizlan commented 1 year ago

Wouldn't the API do this

Yeah, but not the converse. It would be simpler for now, I guess (?) But you're right that an API would be helpful in locating any rough edges in the database.

fwiw, we've also been thinking about making a Hotseat-ified version of the calendar-view planner – I'm curious about what improvements you're thinking of! Mind if we set up a call? I'd love to learn more and get your thoughts on the API design. I can help get your env set up for Hotseat too!

Oooh, that sounds good! Is hi@nathansmith.io a good address to reach you at?

nathanmsmith commented 1 year ago

@mizlan yes it is!