zmoog / axios Goto Github PK

With the current UX, we only have one command:

$ axis list-grades 
...

But I think this is more flexible:

$ axios grades list

Class agenda contains items for the next few days, including:

• topics
• homework assignments

Here's an example:

I would love to have a command available to list them:

$ axios agenda list

I forgot to clean up some helper I used to get the HTML pages for inspection.

We don't need to create these files, please remove all of them.

This is for testing the available options.

I can think of the following questions:

• Are there some APIs available, or we need to scrape the website?
• tba

Right now credentials are hard coded, and it's (partially) fine because this project is just a hack.

To avoid leaking credentials (again). we should pass username and password properly.

The grades list has minor inconsistencies I want to address to make a cleaner UX.

Here's the kind of interactions I want to have.

Setup

# User authentication
export AXIOS_USERNAME="1234"
export AXIOS_PASSWORD="whatever-it-works"
export AXIOS_CUSTOMER_ID="12345678909"

# Student — user account can have multiple students (when parents have two or more kids in the same school)
export AXIOS_STUDENT_ID="00004567" 

Basic Usage

$ axios grades list

                                                                                         Grades

  Data         Materia                      Tipo      Voto   Commento                                                                                             Docente
 ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
  23/12/2022   ITALIANO                     Scritto   6.5    Tema in classe                                                                                       Rapalino Lara
  22/12/2022   LINGUA STRANIERA INGLESE     Orale     8,5    Interrogazione                                                                                       Barbero Daniela

We should avoid setting environment variable in the GitHub Actions workflow: it makes the text longer and the result is less flexible.