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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file studentvue-2.0.2.tar.gz.

File metadata

  • Download URL: studentvue-2.0.2.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.4

File hashes

Hashes for studentvue-2.0.2.tar.gz
Algorithm Hash digest
SHA256 f332ad52da959c88dd221e3d38ba34e6ac6d97fb7278307897c18f3dbe29d4c2
MD5 f13fea2a692afb9fd58c141e4180ceaa
BLAKE2b-256 9da3521b361f17a18b91d26587ed51b4e0d694eaf9f11aeb2768263c48b7f023

See more details on using hashes here.

File details

Details for the file studentvue-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: studentvue-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.4

File hashes

Hashes for studentvue-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a336a5ef278852fc885330b48ba8e2732b1d5d9f35eddba7215a90ce5431042d
MD5 da702ec7f11a0492bf0fc9f9f1eb62f7
BLAKE2b-256 e1cb026faa53b9b00399d9028d8df35442425555c9ccc09c2dd0c8b770665bc8

See more details on using hashes here.

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