fantasyethan/abc-classroom

Tools to automate github classroom and autograding workflows

UPDATE: abc-classroom is in a transition period where maintainence will slow down. We are open to new maintainers so please reach out via an issue if you are interested. The main work that needs to happen at this point is a better object-oriented test suite that makes it easier to contribute to the package without the big worry of breaking things. There are plans to have a developer spend some time on this package but this likely won't happen until later in the year (2022).

Why ABC Classroom

Many educators teaching data science are using GitHub Classroom as a way to teach students both git and GitHub skills and also potentially collaboration skills that align with open source software development best practices. However there are many steps associated with using GitHub classroom to manage a class.

Abc-Classroom contains a suite of command-line utilities that make it easier to manage a class of students using GitHub classroom by:

1. Making it easier to create template assignment directories that are directly connected to your classroom organization
2. Making it easier to update those assignments and
3. (still under development) making it easier to clone all student assignments for grading.

We are currently using nbgrader in our workflow and are thus building this tool out to support the use of nbgrader as well.

Install abc-classroom

abc-classroom is under significant development currently. We are occasionally pushing releases to pypi and conda-forge.

For now, install from PyPi using:

$ pip install abc-classroom

Or conda-forge:

$ conda install -c conda-forge abc-classroom

Or to get the most current updates, clone this repo and run:

$ pip install -e .

to install the development version.

Use Abc-classroom

Because this is a command line set of tools, you will need to ensure that abc-classroom is installed in the active environment that you are using for your class.

Active Maintainers / Developers

How to Contribute

We welcome contributions to abc-classroom as we are developing it and beyond! Please be sure to check out our contributing guidelines for more information about submitting pull requests or changes to abc-classroom.

License & Citation

BSD-3