From bc49e32b161883cb7c2af8f5a1cb623266a39e07 Mon Sep 17 00:00:00 2001
From: Christopher Bohn <bohn@unl.edu>
Date: Mon, 14 Oct 2019 07:52:16 -0500
Subject: [PATCH] updated README to reflect new structure plan
---
README.md | 14 ++++++--------
api/.gitignore | 2 ++
api/config.py | 5 ++---
{automation => old-automation}/01-clone.py | 0
{automation => old-automation}/05-extract_teams.py | 0
{automation => old-automation}/README.md | 0
6 files changed, 10 insertions(+), 11 deletions(-)
create mode 100644 api/.gitignore
rename {automation => old-automation}/01-clone.py (100%)
rename {automation => old-automation}/05-extract_teams.py (100%)
rename {automation => old-automation}/README.md (100%)
diff --git a/README.md b/README.md
index 830d459..51f0ca0 100644
--- a/README.md
+++ b/README.md
@@ -3,18 +3,16 @@
These python and bash scripts (and a C program) serve to automate assignment
management, with an eye toward scaling to larger class sizes.
-In the repository, the scripts are divided into those that interface with
-remote systems and those that automate the tasks. In practice, you'll want to
-place both in the same directory, specifically the directory in which you'll
-collect students' repositories for grading.
+The scripts that interface with remote systems are in the `api` directory, and
+the scripts that do work are in the top-level directory.
-- apis/
+- api/
- Directory containing functions that interface with `git.unl.edu` and
`canvas.unl.edu`. When you copy these to the grading directory, place
your api keys in `config.py`.
-- automation/
- - Directory containing scripts to clone, create, process, etc., student
- repositories.
+- old-automation/
+ - Directory containing early fall 2019 scripts to clone, create, process,
+ etc., student repositories.
- 1195
- Directory containing scripts from summer 2019 pilot of new course
structure. Should be obsolete (and removed) by end of fall 2019.
diff --git a/api/.gitignore b/api/.gitignore
new file mode 100644
index 0000000..3c58b14
--- /dev/null
+++ b/api/.gitignore
@@ -0,0 +1,2 @@
+config.py
+
diff --git a/api/config.py b/api/config.py
index e99fac8..fc0dc94 100644
--- a/api/config.py
+++ b/api/config.py
@@ -1,9 +1,8 @@
class Config:
# GitLab API Configuration
gitlab_url = 'https://git.unl.edu/'
- gitlab_api_key = None
+ gitlab_api_key = 'this shouldn\'t be here'
# Canvas API configuration
canvas_url = 'https://canvas.unl.edu/api/v1/'
- canvas_api_key = None
-
+ canvas_api_key = 'this shouldn\'t be here'
diff --git a/automation/01-clone.py b/old-automation/01-clone.py
similarity index 100%
rename from automation/01-clone.py
rename to old-automation/01-clone.py
diff --git a/automation/05-extract_teams.py b/old-automation/05-extract_teams.py
similarity index 100%
rename from automation/05-extract_teams.py
rename to old-automation/05-extract_teams.py
diff --git a/automation/README.md b/old-automation/README.md
similarity index 100%
rename from automation/README.md
rename to old-automation/README.md
--
GitLab