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.1.1.tar.gz (7.3 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.1.1-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pl_viz-0.1.1.tar.gz
  • Upload date:
  • Size: 7.3 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.1.1.tar.gz
Algorithm Hash digest
SHA256 7a2e99576cf8829c3ac12ea59ef52f5f3dc72ca5bd0db2ed6121364d4d568d7d
MD5 d46f2b93b344bf18fab4ab088b0e7eaa
BLAKE2b-256 901066670f6c5b16614f18627e459a0824dee367917a6be9d357e5bb3a908bfd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pl_viz-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.2 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6429d13a89b5b6e5188fb070ea0def789dabc80f453703e86dc2378489b4074
MD5 05a18bfd3e7315710a8eabd700ce42a0
BLAKE2b-256 413ed2c31d46c491642a924a0faa65e67959fbad244c9052dfa722cb9e56ed9a

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