https://github.com/btskinner/grm
GitHub CLI classroom manager
https://github.com/btskinner/grm
classroom-tools git python
Last synced: 5 months ago
JSON representation
GitHub CLI classroom manager
- Host: GitHub
- URL: https://github.com/btskinner/grm
- Owner: btskinner
- License: mit
- Created: 2016-07-30T16:27:26.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T02:13:53.000Z (almost 4 years ago)
- Last Synced: 2025-06-01T08:33:55.547Z (7 months ago)
- Topics: classroom-tools, git, python
- Language: Python
- Homepage: https://www.btskinner.io/grm
- Size: 963 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GitRoom Manager
===============
[](https://travis-ci.org/btskinner/grm)
[](https://github.com/btskinner/grm)
[](https://pypi.org/project/grm/)
GitRoom Manager allows instructors to more easily manage a GitHub-based
virtual classroom. From within the program, the user can:
- Initialize student repositories, locally and remotely, from a CSV
roster and a local master repository
- Add students to an existing course
- Add administrators to the course (other instructors)
- Associate each student with a personal private repository
- Update student repositories with new course content
- Pull from/push to student repositories
- Grade assignments
Requirements
------------
- Python >= 3.3
- Git >= 2.0
- Ownership of a [GitHub Classroom](https://classroom.github.com/)
- [GitHub Personal
Token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)
with full permissions
- Class roster with columns for student: first name, last name, GitHub
ID
Installation
------------
To install the `grm` module, clone the repository to your local machine
and `cd` into the top-level directory. From the terminal, type:
python setup.py install
*NOTE:* You may need to use `python3` or `python3.x` in place of
`python` in order to utilize a Python 3.x installation.
You may also install with pip:
```bash
pip install grm
```
*NOTE:* Depending on your installation may need to use `pip3` in place of
`pip`.
Usage
-----
You can call GitRoom Manager from within an interactive Python session
by calling:
```python
import grm
grm.main()
```
The installation also adds an executable script to your path. You can
call GitRoom Manager from terminal using:
```bash
$ gitroom
```
*NOTE:* The command line script is just a wrapper for the first set of
commands above. The script searches your environment for your Python 3.x
interpreter. If it cannot find it, the script may revert to your system
Python interpreter---which is often 2.x---and may fail. If you have
trouble with the command line script, first make sure that your Python
3.x interpreter is in your system path and callable by `python3`.
Manual
------
A more complete manual for GitRoom Manager can be found at
[btskinner.io/grm](http://btskinner.io/grm)