Skip to main content

Fetch and visualize data from PL.

Project description

prairielearn-viz

pl_viz is a Python package designed to simplify data extraction and visualization for courses on PrairieLearn. With its object-oriented design, pl_viz makes it easy to fetch data for courses, students, and assessments, and generate insightful visualizations to analyze student performance and assessment outcomes.

Features

  • Object-Oriented Design: Includes Course, Student, and Assessment classes for modular and intuitive data handling.
  • Data Extraction: Fetch student lists, assessment details, and submission scores directly from the PrairieLearn API.
  • Data Visualization:
    • Boxplots for score distributions across assessments.
    • Histograms to analyze score frequency.
  • Summary Statistics: Compute mean, median, min, and max scores for assessments.

Installation

To install the pl_viz package, use the following command:

pip install pl_viz

Usage

You will need a PrairieLearn API token to use this package. Store the token as an environment variable for security:

export PL_API_TOKEN="your_api_token_here"

Classes Overview

  1. Course

Represents a PrairieLearn course. Use it to:

  • Fetch students and assessments.
  • Display summary statistics.
  • Generate visualizations.
  1. Student

Represents an individual student, providing access to their user ID, name, and UID.

  1. Assessment

Represents an assessment within a course. Fetch submissions and analyze score distributions.

Contributing

Contributions are welcome! If you’d like to contribute to pl_viz, please open an issue or submit a pull request. Ensure you follow the coding standards and add tests for new features.

License

This project is licensed under the MIT License. See the LICENSE file for details.

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

pl_viz-0.3.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pl_viz-0.3.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file pl_viz-0.3.0.tar.gz.

File metadata

  • Download URL: pl_viz-0.3.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pl_viz-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8309c72b65c4d8ab24b348209b003b5f00866e0a6d667f5d104a69257071068a
MD5 a32acd5a1c483fdb72e21b297f525f42
BLAKE2b-256 d60dc6445984b0743961e4c14fc446786ca979820c056fc9afbfeffb183cc746

See more details on using hashes here.

File details

Details for the file pl_viz-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: pl_viz-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pl_viz-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e4878319e727bd24aa7a891d75a87192bc0bab79fbba4e320a96e30f359a6d4
MD5 9d81722a43c0c6e653385df78d9fd9fb
BLAKE2b-256 f91d2ff8943781a4a79f2394343f22d112c5cad652df81cff5ffde9a607d6b80

See more details on using hashes here.

Supported by

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