nixiwang / pisanalysistool Goto Github PK

Your functional specification looks good. But I didn't see code? I strongly recommend that you try to accelerate your progress since the quarter goes very quickly.

Not sure about this, but in the example note book PISAnalysisTool/Examples/get_student_info.ipynb there are some functions defined. Should these be part of the module itself?

Much looks good. Some things to look at:

1. You have some code that's well documented, and other cases where the comments do not match the code (e.g., data_cleaning.py / data_cleaning). You need to clean this up.
2. named constants should be in capital letters (e.g., mapdata.py)
3. The tests you have look reasonable, but there are a lot of missing tests.

Recall package names need to be lowercase with very limited use of underscores

More unit tests should be written that go beyond just checking if the code explodes.

I see some spurious files and directories that shouldn't be in your repo, e.g. .DS_Store

The README.md needs to be updated with things like installation instructions and links to or explicit instructions on how to use the repo.

I loved the examples you gave during the practice presentation but I can't find them readily in the repo. Maybe links to them in the README.md would help if they are there?

Is the codebase PEP8 compliant? Some lines look long. Most functions don't have docstrings.