abc-classroom.quickstart

abcclassroom.quickstart.create_dir_struct(course_name='abc_course', force=False, working_dir=None)

Create a directory structure that can be used to start an abc-classroom course. This includes a main directory, two sub directories for templates and cloned files, and a start to a configuration file.

This is the implementation of the abc-quickstart script; it is called directly from main.

abcclassroom.quickstart.path_to_example(dataset)

Construct a file path to an example dataset, assuming the dataset is contained in the ‘example-data’ directory of the abc-classroom package. Adapted from the PySAL package.

Parameters

dataset (string) – Name of a dataset to access (e.g., “config.yml”)

Returns

A concrete Path object to the dataset

Return type

Path object

abc-classroom.ok abc-classroom.scrub-feedback