Package: vicedtools
vicedtoolsThis is a collection of utility tools for working with school data in Victorian schools.The utilities have been designed to be state-less. Where tools have been created to export data then they have been designed to work with the native export formats provided by the relevant sites so that processing functions also integrate with existing data stores.Currently includes tools for:automating the exporting of data from Compass, ACER's OARS site, the VCAA data service (NAPLAN) and VASS (VCE results).tools for working with ACER's OARS site, such as working with PAT dataextracting NAPLAN data from the SSSR data.js fileuploading data to Google Cloud storage and BigQuery for use with Looker StudioThe core export functions are provided by the CompassSession, OARSSession, VASSSession and DataServiceSession classes.Getting startedInstallationInstall frompippip3installvicedtoolsTo use the bundled scripts for performing exports and aggregating exported data, make a copy of'config-sample.toml', update it with your credentials, and then set the VICEDTOOLS_CONFIG environment variable to point to the config file.UsageExporting from VASSCreate a session and select a year.fromvicedtoolsimportVASSSessiongrid_password=[('1','1'),('8','1'),('4','5'),('5','5'),('1','8'),('8','8')]s=VASSSession(username=username,password=password,grid_password=grid_password)year="2021"s.change_year("year")Exports from the main VASS interface.s.personal_details_summary(f"personal details summary{year}.csv")s.school_program_summary(f"school program summary{year}.csv")s.gat_summary(f"gat scores{year}.csv")s.school_scores(f"school scores{year}.csv")s.external_results(f"external scores{year}.csv")s.moderated_coursework_scores(f"moderated coursework scores{year}.csv")Some data is only available once the VCE data service is updated.s.predicted_scores(f"predicted scores{year}.csv")Exporting from OARSCreate a session.fromvicedtoolsimportOARSSession,OARSBasicAuthenaticatoroars_authenticator=OARSBasicAuthenaticator(oars_username,oars_password)s=OARSSession(oars_school_code,oars_authenticator)Exporting student details.candidates=s.get_candidates()withopen("oars_candidates.json",'w')asf:json.dump(candidates,f)Export staff details.s.get_staff_xlsx("oars_staff.xlsx")Export test results.sittings=s.get_all_pat_sittings("01=01-2020","31-12-2021")withopen("sittings 01-01-2020 31-12-2021.json",'w')asf:json.dump(sittings,f)Exporting NAPLAN results from the VCAA data serviceCreate a session.fromvicedtools.naplanimportDataserviceSession,DataServiceBasicAuthenticatordataservice_authenticator=DataServiceBasicAuthenticator(dataservice_username,dataservice_password)s=DataserviceSession(dataservice_authenticator)Export outcome Excel files.s.export_naplan("2021, "./naplanresults/")Export the SSSR.s.export_sssr("2021, "./naplansssr/")Bundled command-line utilitiesThe following command-line utilities are bundled with the package.compassreportstobqcompassstudentdetailstobqcompassstudentenrolmenttobqcreatecompassreportssummariescreatecompasssubjectsmetadatacsvcreatenaplansummarycreateoarsstudentimportscreatepatparentlettertableewritescorestobqewritesittingstoscoresexportcompassacademicgroupsexportcompassclassesexportcompassenrolmentsexportcompasslearningtaskexportcompasslearningtasksexportcompassprogressreportexportcompassprogressreportcyclesexportcompassprogressreportsexportcompassreportexportcompassreportcyclesexportcompassreportsexportcompasssdsexportcompassstudenthouseholdinformationexportcompassstudentsexportcompasssubjectmetadataexportnaplanoutcomesexportnaplansssrexportoarsmetadataexportoarssittingsexportoarsstaffexportoarsstudentsexportvassexternalscoresexportvassgatscoresexportvassmoderatedscoresexportvasspredictedscoresexportvassschoolprogramexportvassschoolscoresexportvassstudentdetailsnaplanoutcomestobqpatmostrecentobqpatscorestobqpatscorestomostrecentpatsittingstoscores