First API Commit

[thierrylahaije]

This commit contains the following changes:

• gen folder added: contains rendered .csv files & sql statements
• sql_app folder added: contains the fast api files and the sqlite database.

To run the Fast API:

• Clone locally, open terminal and go to the sql_app folder. Run the following command: uvicorn main:app --reload

[hannesdatta]

I've checked this out! Great progress!!!

A few comments:

• [ ] some of the packages in Python weren't installed on my computer so the thing crashed (and I had to manually install the packages). Does it make sense using some kind of Python environment where we specify the required packages using version numbers? Or do we seek to achieve this w/ docker in the next step?
• [x] please move the running instructions to the repos' readme.md (create it)
• [x] please add to the readme.md how to open the documentation of the API (it's self-generated, right?)
• [x] I don't really know how to make API requests - I tried pointing my browser to http://127.0.0.1:8000/users?limit=10, but I get an internal server error.
• [x] Please be a bit more diligent in using git issues to work on stuff - I think this PR should have been addressed/linked in issue #3

Some server errors below when trying to run http://127.0.0.1:8000/users?limit=10 or http://127.0.0.1:8000/users

  field required (type=value_error.missing)
response -> data -> 7 -> favorite_track
  field required (type=value_error.missing)
response -> data -> 8 -> user_info
  field required (type=value_error.missing)
response -> data -> 8 -> total_plays
  field required (type=value_error.missing)
response -> data -> 8 -> favorite_artist
  field required (type=value_error.missing)
response -> data -> 8 -> favorite_track
  field required (type=value_error.missing)
response -> data -> 9 -> user_info
  field required (type=value_error.missing)
response -> data -> 9 -> total_plays
  field required (type=value_error.missing)
response -> data -> 9 -> favorite_artist
  field required (type=value_error.missing)
response -> data -> 9 -> favorite_track

[thierrylahaije]

• some of the packages in Python weren't installed on my computer so the thing crashed (and I had to manually install the packages). Does it make sense using some kind of Python environment where we specify the required packages using version numbers? Or do we seek to achieve this w/ docker in the next step? : Yes, in the next step we will make sure the docker file and/or the flask app automatically should achieve this.

• please move the running instructions to the repos' readme.md (create it) : Done 👍

• please add to the readme.md how to open the documentation of the API (it's self-generated, right?) : Done 👍

• I don't really know how to make API requests - I tried pointing my browser to http://127.0.0.1:8000/users?limit=10, but I get an internal server error. : There were some errors in the crud and schemas files. I updated them and now all endpoints are working. 👍

• Please be a bit more diligent in using git issues to work on stuff - I think this PR should have been addressed/linked in issue https://github.com/tilburgsciencehub/apis-to-scrape/issues/3 : Maybe we should talk about this in a meeting so that it is clear for me what you mean.

[thierrylahaije]

@hannesdatta some test endpoints so you can check the functionality:

User list endpoint: http://127.0.0.1:8000/users?limit=5&offset=5 User endpoint: http://127.0.0.1:8000/users/username?username=user3 Total plays endpoint: http://127.0.0.1:8000/users/totalplays?username=user20

[hannesdatta]

This is a good initial push. We can define the next steps in new issues and discuss when meeting next.