https://github.com/fullstackacademy/popsicle-sticks
A class instructional tool to assist in cold calling students.
https://github.com/fullstackacademy/popsicle-sticks
Last synced: 12 months ago
JSON representation
A class instructional tool to assist in cold calling students.
- Host: GitHub
- URL: https://github.com/fullstackacademy/popsicle-sticks
- Owner: FullstackAcademy
- Created: 2021-04-14T02:41:16.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-14T02:57:41.000Z (about 5 years ago)
- Last Synced: 2025-05-17T23:08:57.439Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 4.55 MB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Popsicle Sticks
[]()
[](https://github.com/FullStackAcademy/popsicle-sticks/issues)
[](https://github.com/FullStackAcademy/popsicle-sticks/pulls)
---
A class instructional tool
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Built Using](#built_using)
- [Contributing](./CONTRIBUTING.md)
- [Authors](#authors)
Popsicle Sticks is a program intended to facilitate cold calling students during class in a way that is fair, random, and trackable. Popsicle Sticks provides an option to run as a GUI or CLI and allows the ingestion of class rosters from a csv file.
You can run clone this repository with the `git clone` command and run directly from source, or you can use our `releases` and grab the binary for your operating system.
### Prerequisites
`python 3.7.5` is a prerequisite to running this program from source. If you need help installing Python in your environment, follow the instructions [here](https://docs.Python.org/3/using/windows.html).
```
$ python --version
Python 3.8.2
```
### Installing
To run from source, you must install the requirements.
```
python -m pip install -r requirements.txt
```
### CLI Options
```console
$ python popsicle_sticks_cli.py
usage: popsicle_sticks_cli.py [--help] [create, add, remove, reset, destroy, pull]
optional arguments:
--help show this help message and exit
modules:
create accept student names and create database
add [student] add a single student to the database
remove [student] remove a student from the database
reset [student] if a single student is provided, reset student's counter, else reset entire database
destroy destroy the database, removing all students
```
### GUI Options
- [Python](https://www.Python.org/) - Language
- [Pandas](https://pandas.pydata.org) - CSV Parsing
- [PySimpleGUI](https://github.com/PySimpleGUI/PySimpleGUI) - GUI Framework
- [@DeemOnSecurity](https://github.com/DeemOnSecurity)