ed-api-client 0.1.3

A client for interacting with the Ed LMS

ed-api-client

A Python client for the Ed LMS API, with utilities for analysing student workspace activity.

Installation

pip install ed-api-client

Quick start

from ed_api_client import EdClient

client = EdClient(token="your-api-token")

# Retrieve all students in a course
users = client.get_users(course_id=12345, role="student")

# Retrieve the module/lesson structure
modules = client.get_module_structure(course_id=12345)
for module in modules:
    for lesson in module.lessons:
        print(lesson.title)

# Fetch and analyse a student's workspace activity
log = client.get_workspace_log(workspace_id="abc123")
files = client.get_scaffold_files(challenge_id=99)
summary = WorkspaceSummary.from_log(files, log)

print(summary.total_active_time)
for file_id, file in summary.file_summaries.items():
    print(file.path, file.pasted_proportion, file.cursor_entropy)

Full API reference: https://dmilne.gitlab.io/ed-api-client

Development

Prerequisites

• Python 3.10+
• Poetry

Install Poetry via Homebrew:

brew install poetry

Setup

Clone the repository and install all dependencies (including dev dependencies):

git clone https://gitlab.com/dmilne/ed-api-client.git
cd ed-api-client
poetry install --with dev

Running tests

poetry run pytest tests/ -v

Tests use the responses library to mock HTTP calls — no real Ed credentials are needed.

Viewing the docs locally

poetry run mkdocs serve

Then open http://localhost:8000.

Publishing a new version

1. Bump the version:

   poetry version patch   # or: minor, major
   

2. Configure your PyPI token (first time only):

   poetry config pypi-token.pypi your-token-here
   

   Get a token at https://pypi.org/manage/account/token/.

3. Build and publish:

   poetry publish --build
   

CI/CD

The GitLab pipeline (.gitlab-ci.yml) runs on every push:

• test — runs pytest against Python 3.11
• pages (main branch only) — builds and deploys the MkDocs site to GitLab Pages at https://dmilne.gitlab.io/ed-api-client

License

MIT