---
tags: tool-development, quickstart, documentation
---

## ABC-INIT
- Follow directions in CONTRIBUTING.rst file to the end of the document.
- Run `abc-init` in Git Bash.
- Enter username and password upon prompt.
- When you do this a token will be created for you in github called grading workflow helper

> [name=Leah Wasser]we should rename this token - should be easy to do!

## ABC-DISTRIBUTE -- nathan will write docs here

# Course Starter for ABC Classroom

## Step One - Create Organization & Associated GitHub classroom
> []test comment
> []
To begin using `ABC-classroom` you will need a GitHub organization setup with an associated github classroom.

- [Create a new GH organization](https://github.com/organizations/new)
- [Create a new GH classroom within that organization](https://classroom.github.com/classrooms/new)

This GitHub classroom is where your:

* template classroom and
* all student repositories created from that template

will live. Take note of the name of this organization name as you will need to add it to the `config.yml` file later.

### Notes about GitHub Classroom

If you have used GitHub classrooms before you will notice that in the normal GitHub classroom setup each assignment has it's own repository. However with ABC-classroom each class has one repository.

When you apply for your classroom, you will be asked to verify your status as an educator. An education flagged organisation can have infinite private repositories. This will ensure that students can not see each other's work.

(## Step two - Create a "classroom" repository that will become your template

Within your github classroom account, create a new assignment (repository). This repository will become the template that you use to store new assignments and content that you wish to share with your class. Note that`-template` will be added to the classroom repo name when you start using ABC-classroom below.
# ^^^ TIM is this how it works? is it an assignment but template gets added later to the name in the distribute --template step? ?)

# *Is the above correct???*
Tim thinks we need to do a variation of this at a later stage. We first run `abc-distribute --init` (to create the repository that is copied by GitHub classrooms to create the template repository) and then create the "assignment". This is because when creating the assignment you have to specify what repository to use as a template.

Example: `course-name-2019`

This course name will be added to your config file below.

## Step Three - Install ABC-classroom locally
Next, install `ABC-classroom` which currently lives on GitHub.

`$ pip install --upgrade git+https://github.com/earthlab/abc-classroom.git`

## Step Four - Clone or Copy the abc-course-starter repo

You are now ready to clone or make a copy locally of the abc-classroom course starter. You can do this at the command line using:

> Note: git needs to be installed on your computer for the command below to work properly.

`$ git clone https://github.com/earthlab/abc-course-starter`

Once this repo is installed, cd to it at the command line:

`$ cd abc-course-starter`

You want to be in the top directory of this repository to run the next few steps.

## Step Five - Configure your course starter repository

You are now ready to configure your course repsitory. To begin, open the `config.yml` file.

Add your GitHub username to the list of students so you can test out your classroom assignments as a student.

students:
- betatim
- jlpalomino
- lwasser

Add your organization to the yaml file too along with your course name. The course name will be used to prefil all student and template repositories in the classroom as follows:

https://github.com/<organisation>/<courseName>-template
https://github.com/<organisation>/<courseName>-

organisation: earth-analytics-edu
courseName: ea-spring-2019-template

At the command line, run `abc-init` to get a GitHub access token. The access token lets the ABC-classroom tools perform actions on your behalf on github.com without asking you for your password every time.

`$ abc-init`

You can view the token by going to https://github.com/settings/tokens

The token will be called `Grading workflow helper`

# We need more above on how nbinit works especially if we decide to make it a global element.

## Step xx - Setup Circle CI & notebook bot??

* more from Tim here on what needs to happen with circle ci.

Once you have setup a classroom, you are ready to [install the notebook bot](https://github.com/apps/notebookbot) for the organisation you just created. Make sure to enable it for "all repositories" in the organisation. [Notebook bot code](https://github.com/betatim/notebook-bot)