Metadata-Version: 2.1
Name: ghc-utils
Version: 0.1.2
Summary: utilies for github classroom
Home-page: https://github.com/aronwc/ghc-utils
Author: Aron C
Author-email: aronwc@gmail.com
License: GNU General Public License v3
Keywords: ghc_utils
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: Click (==7.0)
Requires-Dist: github3.py

# ghc-utils
utilities for interacting with github classroom

## Installation

`pip install ghc-utils`

## Usage

### grades

First, create a file named `students.txt` containing each student's github id, one per line.

To download all grades for an assignment named `assignment-01` from an organization name `myorg` and save it to `grades.csv`:

`ghc-utils grades -u <your_githubid> -t <your_github_token> -o <myorg> -a assignment-01 -s students.txt -g grades.csv`

```
ghc-utils grades --help
Usage: ghc-utils grades [OPTIONS]

  Download all grades for an assignment.

Options:
  -u, --username TEXT           your github username  [required]
  -t, --token TEXT              your github personal access token
                                (https://docs.github.com/en/free-pro-
                                team@latest/github/authenticating-to-
                                github/creating-a-personal-access-token)
                                [required]
  -o, --organization TEXT       github organization name, e.g., tulane-
                                cmps2200  [required]
  -a, --assignment-prefix TEXT  assignment name prefix, e.g., assignment-01
                                [required]
  -s, --student-file PATH       text file with one student github id per line
                                [required]
  -g, --grade-file PATH         output csv file  [required]
  --help                        Show this message and exit.
```

Note that passwords are deprecated, so you'll have to create a [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token); only read access is required.

# History

## 0.1.1 (2020-09-03)

- First release on PyPI.

## 0.1.2 (2020-09-20)

- Change password to personal access tokens.


