Skip to content

Commit b03c78d

Browse files
updated readme with contribution invite
1 parent 30ad4c9 commit b03c78d

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

README.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@ Some of them are for admin purposes, others are for course management and
55
pulling out some student data that is hard to get from the admin or course
66
tools.
77

8+
## Using Scripts
9+
10+
To use any of the Python scripts, use `pip install -r requirements.txt` to
11+
install `canvasapi` and dependencies. You should do this is a virtual
12+
environment, if possible. Type annotations are Python 3.7+, but scripts _should_
13+
work in 3.6+. The `canvasapi` library is 3.6+ only.
14+
15+
## Contributions
16+
17+
`pip install -r requirements-dev.txt` to install development packages. `mypy`,
18+
`black`, and `flake8` are for type checks and linting. I don't have many
19+
unittests because many of these scripts are one-offs and not too complex. For
20+
more complicated tools (like `assignment_rubrics`), I do have some tests in
21+
place to check the returned dictionary structure.
22+
23+
This is open for contributions if you have scripts you'd like to share. Open a
24+
PR with the script file and an updated README with a short description of what
25+
it does.
26+
827
### Scripts
928

1029
#### assignment_rubrics
@@ -15,25 +34,25 @@ scores for that assignment. Only Outcomes linked to rubrics are returned.
1534
**Return structure**
1635

1736
```javascript
18-
{
19-
[
20-
'id': 1234,
21-
'name': 'Last, First',
22-
'rubric': {
23-
'123_456': {
24-
'comments': '',
25-
'points': 3.0,
26-
'rating_id': '7364_2363'
27-
},
28-
'987_654': {
29-
'comments': '',
30-
'points': 1.0,
31-
'rating_id': '7364_4639'
32-
},
33-
'score': 92.0
34-
}
35-
...]
36-
}
37+
{
38+
[
39+
'id': 1234,
40+
'name': 'Last, First',
41+
'rubric': {
42+
'123_456': {
43+
'comments': '',
44+
'points': 3.0,
45+
'rating_id': '7364_2363'
46+
},
47+
'987_654': {
48+
'comments': '',
49+
'points': 1.0,
50+
'rating_id': '7364_4639'
51+
},
52+
'score': 92.0
53+
}
54+
...]
55+
}
3756
```
3857

3958
#### associate_blueprint

0 commit comments

Comments
 (0)