Skip to main content

Unofficial Python API Client for StudentVue Portals

Project description

# StudentVue API ![travis](https://travis-ci.com/kajchang/StudentVue.svg?branch=master) ![PyPI version](https://badge.fury.io/py/studentvue.svg)

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](https://github.com/StudentVue-Community/StudentVue-SOAPI-Docs).

## Logging In

pip install studentvue or clone / download the repository and python setup.py install.

`python from studentvue import StudentVue sv = StudentVue('username', 'password', 'domain name') `

## Documentation

You can read some basic docs [here](https://StudentVue-Community.github.io/StudentVue/StudentVue.html).

## Bugs and Contributing

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](https://github.com/kajchang/StudentVue/issues/new) and/or [open a pull request](https://github.com/kajchang/StudentVue/compare).

## Ports

C# - [axiomaticTwist/StudentVueAPI](https://github.com/axiomaticTwist/StudentVueAPI)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

studentvue-2.0.2.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

studentvue-2.0.2-py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page