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.2.1.tar.gz (7.5 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.2.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pl_viz-0.2.1.tar.gz
  • Upload date:
  • Size: 7.5 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.2.1.tar.gz
Algorithm Hash digest
SHA256 9d25ebd18c68550b0a9e8847c7bf3d0c6f61ff7367a56abc4aa7dbc6c8d161bd
MD5 b46515afd06483c0e8019765d436bff7
BLAKE2b-256 906f61477190b483930e0749610cc4ff9f8679a9c912fd88c80b1870770cabc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pl_viz-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0722ffd0dc297fd165fd313217bb8e1865585ce3e6b0992bd9ab8a36afbeb773
MD5 c903814dbd9fe17924cc10da67dd10a8
BLAKE2b-256 f2ce51ec865d5760c5adc1f90c40adeefc7efc9b7d2c28841fdd5be950ae5283

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