Repository navigation
V.A12
This is the submission for A12_publish-module. It has us write stats and validation functions for the Crime_Data_from_2020_to_Present.csv file. The name of the submission folder is 'crime_test'.
In order to get the 'Crime_Data_from_2020_to_Present.csv' file, you need to unzip the 'crime_csv.zip' file and move the csv file from the unzipped 'Crime_Data_from_2020_to_Present' folder to the 'crime_test' folder. The reason why it had to be zipped is because the original csv file was too large to be pushed to GitHub. The 'Crime_Data_from_2020_to_Present.csv' needs to be moved to the 'crime_test' folder because the 'unit_testing.py' file assumes that is where the csv file is.
The 'stats_function.py' contains the functions to calculate the mean and median 'Vict Age'. The 'validate_functions.py' contains the functions to validate the 'Vict Age' and 'Vict Sex' columns. The 'unit_testing.py' contains the unit tests using the 'Crime_Data_from_2020_to_Present.csv' file and 'dirty_data.csv' file. The 'dirty_data.csv' file is a small csv file used for unit testing.
The 'testenv' folder is the virtual environment used to create the 'requirements.txt' file.
The 'setup.py' and 'init.py' files are used to create the package.
The 'A12_publish_module_package.egg-info' and 'dist' folders are the result of building the package using "python3 setup.py sdist bdist_wheel". A 'build' folder containing a file called 'bdist.linux-ppc64le' was also created from building the package, but was unable to be uploaded to GitHub.
### Feedback:
Two other people and I gave feedback to each other in a cycle. I gave feedback to Deema, Deema gave feedback to Aaminah, and Aaminah gave feedback to me, such that everyone gives and receives feedback to/from at least one person. I also gave additional feedback to Aaminah.
Feedback I gave to Aaminah:
I like the organization of the package directory. It was easy to understand where all the files were. The README file was also helpful in understanding how to install the package. I was able to install the package and run the unit tests successfully.
Feedback I gave to Deema:
Hi, I had unzipped the zip file containing the dataset so that the csv file was in the same folder as the other python files, but got this error when I tried running the unit_test.py file
[And then I sent an image of the syntax error I saw]
Feedback I received from Aaminah:
I was able to install you package easily and the until tests ran successfully. I like how you printed out descriptions for each unit test it made it easier to understand what was being tested. Overall great job!