This is a documentation of the Calendar Automation Project I completed during my senior year of high school. I used javascript as my language and used the API platform that google provided to create this program. The program does a 4-day rotation for schools that follow such rotation of classes.
1
stars
1
forks
source link
Add text to the readme file to explain how to set this project up on a local machine. #10
In order for main.py to run, another folder and some other files are needed. This what the file tree will need to look like:
|---- Credentials ---------------------------> (This needs to be created locally)
|---- credentials.json ---------------> (A Google Cloud project needs to be set up and these credentials downloaded from there)
|---- token.json ----------------------> (After the credentials.json file is checked, this file gets created)
|---- Javascript_Version_Files
|---- Python_Version_Files
|---- calendar_building_blocks.py
|---- calendar_details.py
|---- event_templates.py
|---- main.py
|---- main_functions.py
|---- school_specific_info.py -----> (This likely needs to become a template with empty values)
Maybe the best way to handle this is to explain the part about the Credentials folder in the readme file, and maybe even link to the Google Cloud site (linking to the main [console.cloud.google.com](console.cloud.google.com requires login)
Then for school_specific_info.py a template needs to be created. The extent of the file in my local repository is:
More is likely going to need to be in here, or another similar file, but for now those lines above satisfy the import line in main_functions.py from school_specific_info import test_ABCD_calendar_id, ABCD_calendar_id
An example of what may need to go in to this file is the calendar ids for all of the teachers who will their calendars populated with events. That said, those calendar ids will likely be in a dataframe holding all of the other teacher schedule information, and that also should not be included here on GitHub.
In summary: This issue is really to just explain this issue nicely in the readme file. Maybe as that happens or once that happens some ideas for how to handle the private data will be found.
Currently GitHub only shows this file structure:
In order for main.py to run, another folder and some other files are needed. This what the file tree will need to look like:
Maybe the best way to handle this is to explain the part about the Credentials folder in the readme file, and maybe even link to the Google Cloud site (linking to the main [console.cloud.google.com](console.cloud.google.com requires login)
Then for
school_specific_info.pya template needs to be created. The extent of the file in my local repository is:More is likely going to need to be in here, or another similar file, but for now those lines above satisfy the import line in main_functions.py
from school_specific_info import test_ABCD_calendar_id, ABCD_calendar_idAn example of what may need to go in to this file is the calendar ids for all of the teachers who will their calendars populated with events. That said, those calendar ids will likely be in a dataframe holding all of the other teacher schedule information, and that also should not be included here on GitHub.
In summary: This issue is really to just explain this issue nicely in the readme file. Maybe as that happens or once that happens some ideas for how to handle the private data will be found.