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
Course
Represents a PrairieLearn course. Use it to:
- Fetch students and assessments.
- Display summary statistics.
- Generate visualizations.
Student
Represents an individual student, providing access to their user ID, name, and UID.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pl_viz-0.4.0.tar.gz.
File metadata
- Download URL: pl_viz-0.4.0.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7a5e2a06764c25152a33d180c61ec5036ffc640e9c371aa6dc890227a183e115
|
|
| MD5 |
c97c504c0b2be02aacc8dbc3a1f47050
|
|
| BLAKE2b-256 |
d0e3f3c251e56a168bedc0ffa8a0d78e12dcbdd1c44ad8c0d091cc34354a97d0
|
File details
Details for the file pl_viz-0.4.0-py3-none-any.whl.
File metadata
- Download URL: pl_viz-0.4.0-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0f4bbc5d19161821d8aeb0047345b643dcd256e1c01a579586b10241f02f3409
|
|
| MD5 |
8e82cb12c17c0cad8f6922379d31de02
|
|
| BLAKE2b-256 |
436aa21a80eb1ce58f3104c753e0f60b39180975736a005962cab86597e3515c
|