bripollc
commented
1 year ago Ana,
First of all second project completed! You have put a lot of effort into it and this is shown by this great job!!!!!!! Congratulations 💪💪 I leave you some feedback:
🧹 Repository organization
- First of all watch out 👀, that your repository is in a folder inside a folder "project_pipelines/project_data_pipeline" and it should all be outside in a main folder.
- Your repository has no unnecessary documentation so perfect. But it's a bit unstructured.... I would put all the images in the images/ folder and the working notebooks into another folder. Finally, in the src/ folder I would just leave the .py files and remove or not push .ipynb_checkpoints (which is an empty folder) and also pycache.
👨🏽💻 Code
- As in the previous project, your code is very well ordered, clean, divided into files according to what you are working on and it is understood what you are doing. Congratulations, it looks great!
- Also... Very well encapsulated and modularized all in functions!!!! How nice.🥲 I know it can be a bit hard at first and it can be frustrating when you break the code, but it's matter of practice and patience.
- The next step will be to put docstrings inside the functions to document and make it easier to understand what each one does. But step by step! :)
- As for the data extraction part, which was the goal of the project, I'm missing a little bit of depth since you have only scraped one table. I know you had problems with the APIs at the beginning and that slowed down the pace of the project, but I encourage you not to be afraid of them! Other than that all good in your code:)
🎨 Visualizations
- As in the previous project, nice visualizations! There are titles, labels, captions.... Maybe some of the graphics are more representative than others, which don't provide much information but overall pretty good. You also didn't have much data to work with and maybe that's why you couldn't go deeper in this part.
✍🏽 Readme
- The organization is perfect, with headings, subheadings, bulletpoints, images etc. It makes the reading very fluid and visual, overall very easy to follow the story of your project and understand your hypothesis and conclusions.
- The only thing... I'm a bit confused by your hypothesis 3, because you say you have created a scatter plot but the image is a correlation. Did you want to put another plot there?
I know that at the beginning it was hard to start and get the rhythm, but when I see the project I can see the hours behind it:) Overall good work and few things to polish. Keep it up Ana, don't let the energy drop, you already have half a course passed! 🚀🚀🚀
https://github.com/anaaristow/project_2.git