https://github.com/gatoreducator/cellveyor
https://github.com/gatoreducator/cellveyor
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/gatoreducator/cellveyor
- Owner: GatorEducator
- License: gpl-3.0
- Created: 2023-10-31T15:44:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-18T23:58:09.000Z (over 1 year ago)
- Last Synced: 2025-05-08T00:02:37.013Z (about 1 year ago)
- Language: Python
- Size: 1.14 MB
- Stars: 3
- Watchers: 3
- Forks: 6
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cellveyor
[](https://github.com/GatorEducator/cellveyor/actions/workflows/build.yml)
[](https://github.com/psf/black)
[](https://github.com/gkapfham/chasten/graphs/commit-activity)
[](https://www.gnu.org/licenses/lgpl-3.0)
## Example Command
```
poetry run cellveyor --spreadsheet-directory \
/home/gkapfham/working/data/gradebook/2023 --spreadsheet-file
CMPSC-203-Fall-2023-Gradebook.xlsx \
--sheet-name Main \
--key-attribute "Student GitHub" \
--key-value "gkapfham" \
--column-regexp "^(Summary Grade|Final Grade) .*$" \
--feedback-regexp "Summary Grade 1 - Feedback" \
--feedback-file /home/gkapfham/working/teaching/
github-classroom/feedback/all/feedback.yml \
--feedback-file /home/gkapfham/working/teaching/github-classroom/feedback/
developer-development/feedback-overall-course-assessment.yml \
--github-token \
--github-organization Allegheny-Computer-Science-203-F2023 \
--github-repository-prefix computer-science-203-fall-2023-course-assessment \
--transfer-report
```
## 🎉 Introduction
- Cellveyor is a python program that produces assignment reports for students or
classes. Using Cellveyor will publicly give grade reports including feedback for
created assignments. Using the Cellveyor tool will quickly run and send reports to
members included in a locally created google spreadsheet. By running the command
created, this will quickly and automatically send out these reports in a very timely
and efficient fashion.
## 😂 Definitions
- Cellveyor is a tool that automatically produces a report based output by
analyzing a Google sheet
- Student sentence: "I'm glad Cellveyor made it easy for me to see my grades
from my classes, it's so easy to read and analyze."
- Instructor sentence: "Cellveyor makes it much easier for me to tell my
students what their grade looks like on a certain assignment or overall
in the class"
- Researchers sentence: "I found that Cellveyor is a very interesting tool that
quickly and automatically does a task that is necessary in schooling"
## 🔋Features
- 🚀 Fully customizable command line interface
- ✨ Automated generation of grade-based reports sent to students
- 🪂 Rich command line interface with many various arguments
## ⚡️ Requirements
- Cellveyor git hub repository
- Local google sheet
- Git hub token
## 🔽 Installation
Follow these steps to install the Cellveyor program:
1. Copy the ssh key of the repo
2. ```Git clone``` the repository onto your personal computer
- ```git clone (ssh key)```
3. Type ```poetry run cellveyor --help``` to learn how to use the tool