Skip to main content

A CLI for Ed Discussion — browse courses, threads, and comments in terminal

Project description

edstem-cli

A terminal-first CLI for Ed Discussion: browse courses, threads, and comments without leaving the terminal.

Features

  • Courses: list all enrolled courses
  • Threads: list, filter, and sort course threads
  • Thread detail: view full thread with answers and comment tree
  • Activity: browse your activity across courses
  • User profile: view current user info
  • JSON output: export any data for scripting and AI agent integration

AI Agent Tip: Always use --json for structured output instead of parsing the default rich-text display. Use --max to limit results.

Installation

# Recommended: uv tool (fast, isolated)
uv tool install edstem-cli

# Alternative: pipx
pipx install edstem-cli

Install from source:

git clone https://github.com/bunizao/edstem-cli.git
cd edstem-cli
uv sync

Quick Start

Get your API token from: https://edstem.org/settings/api-tokens

# View your profile and courses
edstem user

# List enrolled courses
edstem courses

# List threads in a course
edstem threads 12345

# View a thread with comments
edstem thread 67890

Usage

# Courses
edstem courses
edstem courses --archived
edstem courses --json

# Threads
edstem threads <course_id>
edstem threads <course_id> --sort top
edstem threads <course_id> --category "HW1"
edstem threads <course_id> --type question
edstem threads <course_id> --unanswered
edstem threads <course_id> --max 50 --json

# Thread detail
edstem thread <thread_id>
edstem thread <course_id>#<number>      # by course thread number
edstem thread <thread_id> --json

# Activity
edstem activity                          # all courses
edstem activity <course_id>              # specific course
edstem activity --filter answer --json

# User
edstem user
edstem user --json
# Option 1: Environment variable
export ED_API_TOKEN="your-token-here"

# Option 2: Will prompt on first use and save automatically
edstem user

Configuration

Create config.yaml in your working directory:

fetch:
  count: 30

rateLimit:
  requestDelay: 1.0
  maxRetries: 3
  retryBaseDelay: 3.0
  maxCount: 100
  • fetch.count is the default item count when --max is omitted

Development

# Install dev dependencies
uv sync --extra dev

# Lint + tests
uv run ruff check .
uv run pytest -q

Acknowledgements

This project builds on ideas and structure from
earlier edstem-cli iterations.
Thanks to the original project foundation and subsequent refactors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edstem_cli-0.1.2.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

edstem_cli-0.1.2-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file edstem_cli-0.1.2.tar.gz.

File metadata

  • Download URL: edstem_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for edstem_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9776b0ee5bdf01980168d4e31871b07de9e49014765d7b1075c93eb252f18703
MD5 b40a036675e531ebf559536eb6e8ed42
BLAKE2b-256 2285371c431e0313b8a66cc8f27e61faef58f44c5a237920243dd73318e3b4d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for edstem_cli-0.1.2.tar.gz:

Publisher: publish.yml on bunizao/edstem-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file edstem_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: edstem_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for edstem_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b716b9aaced2ee8cbc4f9a8afae8b863785b2e732884b3f6538542f98ba0d0f
MD5 7a08c6e389e3d17bb1c5fa0856882183
BLAKE2b-256 929b29943bc6f62ae7cd142548b64aeebc26cd6b307269ca8641b640e9ac1cc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for edstem_cli-0.1.2-py3-none-any.whl:

Publisher: publish.yml on bunizao/edstem-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page