This repository provides a easy way to access data from StudentVue portals in Python programs.
This project recently transitioned to using the SOAP API from the app instead of the web-based one. Using the SOAP API is much faster, consistent, and more lightweight. However, the APIs are not compatible, so if you need compatibility the web-based one, run pip install studentvue==1.3.2.
See documentation on the underlying SOAP API here.
pip install studentvue or clone / download the repository and python setup.py install.
from studentvue import StudentVue
sv = StudentVue('username', 'password', 'domain name') You can read some basic docs here.
All data from the API is in XML format, which is hard to use in Python, so the data is automatically transformed into json using xmljson. You can configure the transformation convention using the xmljson_serializer parameter.
Different districts may be running incompatible versions of StudentVue. If you find such an instance or to make general improvements, feel free to raise a new issue and/or open a pull request.