Skip to main content

An unofficial Python wrapper for interfacing with Q Portal

Project description

QPortalWrapper: an unofficial Python wrapper around the Q Portal for grades.

This library provides programmatic access to grades on the Q Portal. You can write scripts or applications that interface with Q and fetch grades.

Example usage:

from qportalwrapper.qportalwrapper import QPortalWrapper, QError

# Connect to the Q portal
conn = QPortalWrapper("Q_URL")

try:
    # Login
    conn.login("USER", "PASS")
except QError as e:
    # Catch an error (failed login, etc.)
    print(e.msg)

# Get a list of viewable students
students = conn.get_students()
print(students)

# Select a student to view
conn.select_student(students[0].id)

# View student's assignment grades
print(conn.get_assignments()[0])

Full docs can be found by running python3 -c "from qportalwrapper.qportalwrapper import QPortalWrapper; help(QPortalWrapper)" in the root repository folder.

QPortalWrapper is currently in alpha. Confirmed working features:

  • Login
  • Student fetching
  • Assignment fetching
  • Progress report fetching

Other features are WIP and should be added soon. Help adding functions would be greatly appreciated.

If you want to help improve or add functionality to QPortalWrapper, file an issue or a merge request.

DISCLAIMER: QPortalWrapper is an unofficial wrapper. It is not sanctioned by any company. It relies on unofficial API endpoints which are subject to change at any time.

Installation

  1. Clone this repo and cd into it.
  2. pip3 install -r requirements.txt to get dependencies (you may need to install pip).
  3. python3 setup.py install (you may need admin permissions).

Project details


Download files

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

Files for qportalwrapper, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size qportalwrapper-1.0.0.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page