vicedtools
This 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 data
- extracting NAPLAN data from the SSSR data.js file
- uploading data to Google Cloud storage and BigQuery for use with Looker Studio
The core export functions are provided by the CompassSession, OARSSession, VASSSession and DataServiceSession classes.
Getting started
Installation
Install from pip
pip3 install vicedtools
To 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.
Usage
Exporting from VASS
Create a session and select a year.
from vicedtools import VASSSession
grid_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 OARS
Create a session.
from vicedtools import OARSSession, OARSBasicAuthenaticator
oars_authenticator = OARSBasicAuthenaticator(oars_username, oars_password)
s = OARSSession(oars_school_code, oars_authenticator)
Exporting student details.
candidates = s.get_candidates()
with open("oars_candidates.json", 'w') as f:
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")
with open("sittings 01-01-2020 31-12-2021.json", 'w') as f:
json.dump(sittings, f)
Exporting NAPLAN results from the VCAA data service
Create a session.
from vicedtools.naplan import DataserviceSession, DataServiceBasicAuthenticator
dataservice_authenticator = DataServiceBasicAuthenticator(
dataservice_username, dataservice_password)
s = DataserviceSession(dataservice_authenticator)
Export outcome Excel files.
s.export_naplan("2021, "./naplan results/")
Export the SSSR.
s.export_sssr("2021, "./naplan sssr/")
Bundled command-line utilities
The following command-line utilities are bundled with the package.
- compassreportstobq
- compassstudentdetailstobq
- compassstudentenrolmenttobq
- createcompassreportssummaries
- createcompasssubjectsmetadatacsv
- createnaplansummary
- createoarsstudentimports
- createpatparentlettertable
- ewritescorestobq
- ewritesittingstoscores
- exportcompassacademicgroups
- exportcompassclasses
- exportcompassenrolments
- exportcompasslearningtask
- exportcompasslearningtasks
- exportcompassprogressreport
- exportcompassprogressreportcycles
- exportcompassprogressreports
- exportcompassreport
- exportcompassreportcycles
- exportcompassreports
- exportcompasssds
- exportcompassstudenthouseholdinformation
- exportcompassstudents
- exportcompasssubjectmetadata
- exportnaplanoutcomes
- exportnaplansssr
- exportoarsmetadata
- exportoarssittings
- exportoarsstaff
- exportoarsstudents
- exportvassexternalscores
- exportvassgatscores
- exportvassmoderatedscores
- exportvasspredictedscores
- exportvassschoolprogram
- exportvassschoolscores
- exportvassstudentdetails
- naplanoutcomestobq
- patmostrecentobq
- patscorestobq
- patscorestomostrecent
- patsittingstoscores
Metadata
Release files for vicedtools 0.0.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vicedtools-0.0.10.1.tar.gz | 73.5 kB | Without provenance | Details for vicedtools-0.0.10.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vicedtools-0.0.10.1-py3-none-any.whl | Python 3 | none | any | Details for vicedtools-0.0.10.1-py3-none-any.whl |
Total release size: 207.1 kB
Release files / vicedtools-0.0.10.1.tar.gz
| Download URL | vicedtools-0.0.10.1.tar.gz |
|---|---|
| Size | 73.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
616d6aa2d244eba4987a00989a4d26e1856023c09d90e01d909b46b7264c1a25
|
|
BLAKE2b-256 checksum How to use checksums |
f8f6a33dd044abbfdcd37cdb0067bac5901e248947ec652dc6bc9e4a2ed62133
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Release files / vicedtools-0.0.10.1-py3-none-any.whl
| Download URL | vicedtools-0.0.10.1-py3-none-any.whl |
|---|---|
| Size | 133.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
970207aa3069d96af0c8476c8b2bf71ab294e0ae7049ed367af785d083554ed8
|
|
BLAKE2b-256 checksum How to use checksums |
4f16a7a08d77a23744fdf418fdd9482fb9a8731cf94be6bff77cdd2ec49786d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Security for vicedtools 0.0.10.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.