{"id":28280139,"url":"https://github.com/yuzhoumo/edbox","last_synced_at":"2025-10-04T22:32:14.902Z","repository":{"id":232779037,"uuid":"785178687","full_name":"yuzhoumo/edbox","owner":"yuzhoumo","description":"Ed course archiver and viewer","archived":false,"fork":false,"pushed_at":"2024-06-27T06:28:57.000Z","size":1288,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T18:44:53.213Z","etag":null,"topics":["alpinejs","edstem","jinja2","python","web-archiving"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuzhoumo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2024-04-11T11:04:56.000Z","updated_at":"2024-07-30T16:14:52.000Z","dependencies_parsed_at":"2024-04-11T12:26:05.582Z","dependency_job_id":"cd56e8a4-44d0-4152-aedf-1f473da1cbd4","html_url":"https://github.com/yuzhoumo/edbox","commit_stats":null,"previous_names":["yuzhoumo/edbox"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yuzhoumo/edbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhoumo%2Fedbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhoumo%2Fedbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhoumo%2Fedbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhoumo%2Fedbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuzhoumo","download_url":"https://codeload.github.com/yuzhoumo/edbox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuzhoumo%2Fedbox/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265672343,"owners_count":23808844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["alpinejs","edstem","jinja2","python","web-archiving"],"created_at":"2025-05-21T10:16:13.586Z","updated_at":"2025-10-04T22:32:14.841Z","avatar_url":"https://github.com/yuzhoumo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\".github/logo.svg\" alt=\"edbox logo\" /\u003e\n\n[![GPLv3 License](https://img.shields.io/badge/License-GPLv3-green.svg)](https://choosealicense.com/licenses/gpl-3.0/)\n\nEdBox is an archiver for Ed courses. Save posts and file attachments from\nEd and generate static sites for local viewing!\n\nBuilt with Python and Alpine.js + Tailwind.\n\n![screenshot](.github/screenshot.png)\n\n## Features\n\n- Archives course info and posts to json files\n- Downloads file attachments and user profile photos\n- Generates an offline, searchable webpage for each archived course\n- Webpages display Ed's formatting options and math notations (LaTeX)\n- Anonymous usernames are correctly generated (matches what's shown on Ed)\n- Color-coded post categories and user profiles\n\n## Installation\n\n```sh\npython3 -m venv venv\nsource ./venv/bin/activate\npip install -r requirements.txt\n```\n\nPython version 3.12 recommended\n\n## Usage\n\n- Generate an Ed API token [here](https://edstem.org/us/settings/api-tokens).\n- Save `ED_API_TOKEN=YOUR_API_TOKEN_HERE` to a `.env` file (see `.env.template`).\n- Run `python3 edbox.py` and choose Ed courses to archive.\n\nIf EdBox fails due to network errors or is otherwise interrupted while\narchiving, restart the program and it will pick up where it left off.\n\n## Development\n\nThere is no need to manually build or install dev dependencies for the webpage\nunless you are making changes to it.\n\n1. Install development dependencies:\n\n```sh\ncd web\npnpm install\n```\n\n2. Add assets downloaded by edbox.py to `web/build/assets`.\n3. Build the site using `pnpm run build`. This generates the `index.html` file\n   and rebuilds the `web/static/tailwind.css` file.\n4. Open `web/build/index.html` to view your changes.\n\n## Acknowledgements\n- [smartspot2's Ed API](https://github.com/smartspot2/edapi)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzhoumo%2Fedbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuzhoumo%2Fedbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuzhoumo%2Fedbox/lists"}