# manage your student's homework
## Description
assuming you have asked your students to create a repo on github to submit their homework,
this script will help you efficiently clone/pull/merge all the repos in a folder, and display a summary of the status of all the repos
## Installation
```bash
pip install collect-homework
```
## Initial setup
1. create a folder where you want to clone all the repos
1. create a file named `00.ids` in the folder
this file should contain the github ids of all the students, one id per line
1. at that point
```bash
collect-homework clone
```
will clone all the repos in the folder
1. in order to pull all the repos in the folder
```bash
collect-homework pull
```
1. you get the gist of it; type
```bash
collect-homework help
```
to see all the available commands
1. of particular interest is the
```bash
collect-homework summary
```
command, which will display a one-line summary of all repos in the folder
1. finally you can focus on one or several students by typing e.g. (this makes sense for most commands)
```bash
collect-homework -s "JohnDoe JaneMartin" pull
```
## handling repo names
assuming you run this command in a folder e.g. `/Users/johndoe/python-homework`:
- then by default all the students are expected to have a repo named `python-homework`
- if this does not match your setup, you can specify the repo name in the `00.reponame` file
this one-line file should contain the name of all the repos, e.g. `python-homework-2024`
- and if a student does not comply with that name, you can specify the repo name in the `00.ids`
file by writing `student/the-repo` instead of just `student`
(you can even put the complete github url instead if that's more convenient for you)
Raw data
{
"_id": null,
"home_page": null,
"name": "collect-homework",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "github, homework, submissions",
"author": null,
"author_email": "Thierry Parmentelat <thierry.parmentelat@minesparis.psl.eu>",
"download_url": "https://files.pythonhosted.org/packages/6b/e5/51ccbb31437c617745d55b1ba4682ddea93aec48a3b759ac43087366572b/collect_homework-0.2.2.tar.gz",
"platform": null,
"description": "# manage your student's homework\n\n## Description\n\nassuming you have asked your students to create a repo on github to submit their homework,\nthis script will help you efficiently clone/pull/merge all the repos in a folder, and display a summary of the status of all the repos\n\n## Installation\n\n```bash\npip install collect-homework\n```\n\n## Initial setup\n\n1. create a folder where you want to clone all the repos\n1. create a file named `00.ids` in the folder \n this file should contain the github ids of all the students, one id per line\n1. at that point \n ```bash\n collect-homework clone\n ```\n will clone all the repos in the folder\n1. in order to pull all the repos in the folder \n ```bash\n collect-homework pull\n ```\n1. you get the gist of it; type\n ```bash\n collect-homework help\n ```\n to see all the available commands\n1. of particular interest is the \n ```bash\n collect-homework summary\n ```\n command, which will display a one-line summary of all repos in the folder\n1. finally you can focus on one or several students by typing e.g. (this makes sense for most commands)\n ```bash\n collect-homework -s \"JohnDoe JaneMartin\" pull\n ```\n\n## handling repo names\n\nassuming you run this command in a folder e.g. `/Users/johndoe/python-homework`:\n\n- then by default all the students are expected to have a repo named `python-homework`\n- if this does not match your setup, you can specify the repo name in the `00.reponame` file \n this one-line file should contain the name of all the repos, e.g. `python-homework-2024`\n- and if a student does not comply with that name, you can specify the repo name in the `00.ids`\n file by writing `student/the-repo` instead of just `student` \n (you can even put the complete github url instead if that's more convenient for you)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Easily manage homework submissions",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/flotpython/collect-homework/issues",
"Repository": "https://github.com/flotpython/collect-homework"
},
"split_keywords": [
"github",
" homework",
" submissions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87d6bb80d902b509b37341a08c8b5948a0a4a5b737f91529de7540f36e61cc7f",
"md5": "a1a77d6934681c48908a901fa6465122",
"sha256": "d1b121d4dca522301e2adaff300b8fadcdaa0dbb8fa6ddc79f49e402f570f0a7"
},
"downloads": -1,
"filename": "collect_homework-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1a77d6934681c48908a901fa6465122",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6751,
"upload_time": "2024-11-04T11:12:16",
"upload_time_iso_8601": "2024-11-04T11:12:16.144394Z",
"url": "https://files.pythonhosted.org/packages/87/d6/bb80d902b509b37341a08c8b5948a0a4a5b737f91529de7540f36e61cc7f/collect_homework-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6be551ccbb31437c617745d55b1ba4682ddea93aec48a3b759ac43087366572b",
"md5": "e1e876c589dd1f7e757d86f075f38301",
"sha256": "c4db966ec952d3ddbe9fd439b0dafcad0fb17dca671f5e9d06d919342f26d34e"
},
"downloads": -1,
"filename": "collect_homework-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "e1e876c589dd1f7e757d86f075f38301",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6800,
"upload_time": "2024-11-04T11:12:17",
"upload_time_iso_8601": "2024-11-04T11:12:17.162663Z",
"url": "https://files.pythonhosted.org/packages/6b/e5/51ccbb31437c617745d55b1ba4682ddea93aec48a3b759ac43087366572b/collect_homework-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:12:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flotpython",
"github_project": "collect-homework",
"github_not_found": true,
"lcname": "collect-homework"
}
JSON
