{"id":16508568,"url":"https://github.com/osteele/assignment-dashboard","last_synced_at":"2026-01-31T19:34:53.504Z","repository":{"id":66371754,"uuid":"81030241","full_name":"osteele/assignment-dashboard","owner":"osteele","description":"A web dashboard for viewing the forks of a classroom assignment repo","archived":false,"fork":false,"pushed_at":"2018-06-18T15:08:41.000Z","size":774,"stargazers_count":2,"open_issues_count":109,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-19T15:41:18.862Z","etag":null,"topics":["classroom-tools","github","jupyter-notebook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osteele.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-05T23:36:22.000Z","updated_at":"2024-04-16T06:11:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"c58aa41a-809f-4894-a42d-fe07df35b0ec","html_url":"https://github.com/osteele/assignment-dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osteele/assignment-dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fassignment-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fassignment-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fassignment-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fassignment-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osteele","download_url":"https://codeload.github.com/osteele/assignment-dashboard/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fassignment-dashboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28951477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T18:30:42.805Z","status":"ssl_error","status_checked_at":"2026-01-31T18:30:19.593Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["classroom-tools","github","jupyter-notebook"],"created_at":"2024-10-11T15:46:12.291Z","updated_at":"2026-01-31T19:34:53.490Z","avatar_url":"https://github.com/osteele.png","language":"Python","readme":"# Assignment Dashboard\n\n[![Updates](https://pyup.io/repos/github/olin-computing/assignment-dashboard/shield.svg)](https://pyup.io/repos/github/olin-computing/assignment-dashboard/)\n[![Requirements Status](https://requires.io/github/olin-computing/assignment-dashboard/requirements.svg?branch=master)](https://requires.io/github/olin-computing/assignment-dashboard/requirements/?branch=master)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bc6108c6014640119f948d0d371dde9d)](https://www.codacy.com/app/steele/assignment-dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=olin-computing/assignment-dashboard\u0026amp;utm_campaign=Badge_Grade)\n\nAssignment Dashboard is a [Flask](http://flask.pocoo.org) web application that displays [Jupyter notebook files](http://jupyter.org) within a GitHub \"assignment\" repository, and their status within each forked \"student\" repository.\n\nThe app displays whether files are present in the student repository; if so, whether they have been changed, and whether they are valid Jupyter notebook files. Student repositories and files are linked to GitHub.\n\n\u003ca href=\"./docs/images/repo.jpeg\"\u003e\u003cimg src=\"./docs/images/repo.jpeg\" width=\"640\"/\u003e\u003c/a\u003e\n\nClicking on an assignment title displays a collated notebook, with all student answers collected beneath each prompt.\n\n\u003ca href=\"./docs/images/collated.jpeg\"\u003e\u003cimg src=\"./docs/images/collated.jpeg\" width=\"320\"/\u003e\u003c/a\u003e\n\nThe app also displays additional information about each assignment.\n\n\u003ca href=\"./docs/images/answer-table\"\u003e\u003cimg src=\"./docs/images/answer-table.jpeg\" width=\"320\"/\u003e\u003c/a\u003e\n\n## Status\n\nThe application does not use authentication, so it should not be run on the open web or in a shared location. (Technically it does not expose any information that is not openly available from the GitHub web interface and API, but it makes this information easier to find.)\n\n## Setup\n\nThese instructions use Docker.\nSee [here](./docs/install-without-docker.md) for alternate instructions that don't use Docker.\n\n![](docs/setup.png)\n\n... generated by [Railroad Diagram Generator](http://www.bottlecaps.de/rr/ui)\n\nDo these once:\n\n### 1. Install docker-compose\n\nFor example: `pip install docker-compose`; or one of the installers [here](https://docs.docker.com/compose/install/).\n\n### 2. Create a GitHub personal API token\n\n[Create a GitHub personal API token](https://github.com/blog/1509-personal-api-tokens).\nSet the `GITHUB_API_TOKEN` environment variable to this value.\n\n### 3. Initialize the database\n\n    docker-compose run web initdb\n\nThis creates a database in `data/database.db`.\n\nIt will take a while to run, as Docker creates the application image.\n\nIf you subsequently need to run it again in order to reset the database, it will use this existing image.\n\n### 4. Add an assignment repository\n\n    $ docker-compose run web add_repo repo_owner/repo_name\n\nAdd a repository to the database, and download its information from GitHub.\n\n## Usage\n\nThese instructions use Docker.\nSee [here](./docs/install-without-docker.md) for alternate instructions that don't use Docker.\n\nThe admin tasks update the project database from GitHub.\nThe web application browses the data in this database.\n\n![](docs/use.png)\n\n... generated by [Railroad Diagram Generator](http://www.bottlecaps.de/rr/ui)\n\n### Admin Tasks\n\n#### Update the database\n\n    $ docker-compose run web updatedb\n\nUpdate the application database with new users and commits from GitHub.\n\n#### Set User Names\n\n    $ docker-compose run web set_usernames usernames.csv\n\nUpdate user names in the database from the rows in `usernames.csv`.\n\n`usernames.csv` should be a CSV file with a column named \"name\" or \"username\",\nand a column that contains the string \"git\" (or mixed-case versions of these\nstrings).\n\nSubsequent execution of `updatedb` will replace usernames in the database\nby the user's GitHub name if the GitHub name is not empty.\n\n\n### Run the Web Application\n\n    $ docker-compose up\n\nThen browse to \u003chttp://localhost:5000\u003e.\n\n\nFile bugs and enhancement requests [here](https://github.com/osteele/assignment-dashboard/issues).\n\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.\n\n\n## Acknowledgments\n\nThe notebook collation code is derived from original work ([paulruvolo/SoftDesSp16Prep](https://github.com/paulruvolo/SoftDesSp16Prep)) by Paul Ruvolo at Olin College, further modified at [osteele/assignment-tools](https://github.com/osteele/assignment-tools).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosteele%2Fassignment-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosteele%2Fassignment-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosteele%2Fassignment-dashboard/lists"}