https://github.com/yuzhoumo/piazzabox
Piazza course archiver and viewer
https://github.com/yuzhoumo/piazzabox
alpinejs piazza python web-archiving
Last synced: 3 months ago
JSON representation
Piazza course archiver and viewer
- Host: GitHub
- URL: https://github.com/yuzhoumo/piazzabox
- Owner: yuzhoumo
- License: mit
- Created: 2024-04-08T06:11:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-02T03:42:21.000Z (about 2 years ago)
- Last Synced: 2025-06-16T18:45:14.523Z (about 1 year ago)
- Topics: alpinejs, piazza, python, web-archiving
- Language: Python
- Homepage:
- Size: 2.7 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://choosealicense.com/licenses/mit/)
Piazzabox is an archiver for Piazza courses. Save posts and file attachments
from Piazza and generate static sites for local viewing!
Built with Python and Alpine.js + Tailwind.
## Features
- Archives course info and posts to json files
- Downloads file attachments and user profile photos
- Generates an offline, searchable webpage for each archived course
- Webpages properly display both markdown and math notations (LaTeX)
- Anonymous usernames are correctly generated (matches what's shown on Piazza)
## Installation
```sh
python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt
```
## Usage
1. Run `python3 piazzabox.py` and enter your login credentials.
2. Choose Piazza courses to archive.
3. Open the generated `index.html` file found in the `out` folder
(alternatively, host this somewhere).
Optional: Rename the `secrets.template.json` file to `secrets.json` and fill
in your Piazza email and password to keep your login credentials saved.
If Piazzabox fails due to network errors or is otherwise interrupted while
archiving, restart the program and it will pick up where it left off.
## Development
There is no need to install dev dependencies for the webpage unless you are
making changes to it. Use the following to install dev dependencies:
```sh
cd web
npm install
# Important: Run after making changes to re-build tailwind css
# npm run build
```
## Acknowledgements
- [Unofficial Piazza API](https://github.com/hfaran/piazza-api)
- [Inspired by Ben Cuan's archive script](https://github.com/64bitpandas/piazza-archiver)