Metadata-Version: 2.1
Name: classroom_utils
Version: 0.4.0
Summary: Utilities to handle stuff likes github orgs for classes.
Home-page: https://github.com/twyleg/classroom_utils
Author: Torsten Wylegala
Author-email: mail@twyleg.de
License: GPL 3.0
Keywords: class classroom github edu education
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema~=4.21.1
Requires-Dist: PyGithub~=2.2.0
Requires-Dist: GitPython~=3.1.42
Requires-Dist: inquirerpy~=0.3.4
Requires-Dist: alive-progress~=3.1.5
Requires-Dist: prompt-toolkit~=3.0.43

[![Build status](https://github.com/twyleg/classroom_utils/actions/workflows/tests.yaml/badge.svg)]()
[![GitHub latest commit](https://badgen.net/github/last-commit/twyleg/classroom_utils)](https://GitHub.com/twyleg/classroom_utils/commit/)
[![PyPI download month](https://img.shields.io/pypi/dm/classroom-utils)](https://pypi.python.org/pypi/classroom-utils/)
[![PyPi version](https://badgen.net/pypi/v/classroom-utils/)](https://pypi.org/project/classroom-utils)
[![Documentation Status](https://readthedocs.org/projects/classroom-utils/badge/?version=latest)](http://classroom-utils.readthedocs.io/?badge=latest)


# classroom_utils

Imagine you are an instructor at a university or school and want to use GitHub to manage exams and projects with your
students. The classroom_utils will help you to automate repetitive processes like assigning students to a certain organization,
granting read or write access to repos or creating personal repos for all class members.

## Installation

You can install the classroom_utils as a python module from pypi via pip with the following command:

    pip install classroom-utils

To make life on Windows a little bit easier you can also use the prebuild version as a self contained binary that ships
with the python interpreter itself and all dependencies.

## Config file

TODO:

## Usage

This is a subset of the provided functionality. Please check the help page (classroom_utils --help) for a complete list:

### Check a class

TODO:

### Initialize an org with personal repos

TODO:

### Manage repo access

TODO: Grant 

TODO: Revoke
