The purpose of the Test Data Generator is to create anonymonized datasets to use as inputs to test the functionality of the Penn-Pal program. Refer to [Penn-Pal] (https://github.com/UPenn-MOSA-Hackathon-Gang-of-Three)
- Bonnie Tse - bonniewt – [email protected] – GitHub
This is used to create anonymonized dataset to test Penn-Pal's matching algorithm functionality.
- Python - Python language (version 3.6 or higher)
- Python Faker - Python Package to generate fake data
- PyCharm - Python IDE
Step 1: Download PyCharm IDE
https://www.jetbrains.com/pycharm/download/#section=mac
Step 2: Download Python version 3.6 or higher
https://www.python.org/downloads/
Check the version of Python. In your Terminal, type:
python3 --version
Step 3: Download Python Faker package. In your (MacOS) terminal, type:
pip install Faker
Give a step-by-step rundown of how to use your project. Including screenshots in this section can be highly effective for highlighting specific features of your project.
Step 1: Download the test data genderator code from penn-pal-testdatagenerator
Step 2: Load the code into PyCharm https://www.jetbrains.com/help/pycharm/importing-project-from-existing-source-code.html
Step 3: In line 35, update the name of the csv output file to a name of your chosing ending with ".csv"
Step 4: In line 55, update the number in the range() function to the number of mentor/mentees you would like in the test dataset
Step 5: Run the program by click the green triangle on the upper right corner of PyCharm.
Step 6: Results will show up under your project folder with the name that you inputted in line 35.
- Python Faker 14.2.0 - Python package used to generate fake data in order to anonymize data.
MIT License
Copyright (c) 2022 Penn-Pal
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.