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.2.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.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pl_viz-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 37cb2095307cad4ba68d1920a316c51f5a31c7a191899fb51cd79f5d06078764
MD5 f723e5f5d44286d5c6eab99b568906a0
BLAKE2b-256 4e5b5852f7fd668c3a9b87e04f6ba60e1f0d911910bbd5fe517d835b772c4b78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pl_viz-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b2a61bda4ed93c4daa3c3e2da5f43211b27a99022afa8ccc60684f91aaf73e65
MD5 9aa7ce873bd8d81255ac8a33a9d07f85
BLAKE2b-256 65beb18e466e5366d12266fc0d431c106b67e4bfe229dacab781a23e9e6950cb

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