Skip to main content

AEMS Local Bridge Agent — local filesystem access for exam PDFs

Project description

AEMS Local Bridge Agent

As of v0.3.2 (2026-05-11), this package is licensed under AGPL-3.0-or-later (previously MIT). The agent links PyMuPDF in-process via aems-pdf-annotator, and AGPL applies to the combined work. See LICENSE for the full text.

A lightweight companion service that runs on localhost and provides REST API access to the local filesystem, enabling the AEMS hosted app to read/write exam PDFs to a user-chosen folder without ever uploading source PDFs to the server.

What it does

  • Runs as a local service on 127.0.0.1:61234 (default).
  • Exposes an authenticated REST API the AEMS web app uses to read source PDFs and write annotated PDFs from your local storage folder.
  • Enforces local Host headers and a PIN-based browser pairing flow before granting the web app access.
  • Optional system-tray icon so it's visible while running.
  • Optional offline grading bundle support for fully-local workflows.
  • Never sends PDF content out unless the user explicitly attaches a Canvas / offline workflow in the hosted app.

Installation

Binary installers (recommended for end users)

Pre-built installers — no Python needed — are on the Releases page.

Platform File Notes
Windows aems-agent-setup.exe Installs to %LOCALAPPDATA%\AEMS Agent
macOS AEMS-Agent.dmg Drag to Applications
Linux aems-agent-linux.tar.gz Extract and run ./aems-agent run

pip (for developers)

pip install aems-agent

Requires Python 3.10+.

Usage

# Print version and exit
aems-agent --version

# Start the agent (default: http://127.0.0.1:61234)
aems-agent run

# Start with system tray icon
aems-agent run --tray

# Custom port/host
aems-agent run --port 9000 --host 0.0.0.0

# Show auth token (the hosted app pairs against this token)
aems-agent token

# Set storage path
aems-agent set-path /path/to/exam/folder

# Show config directory
aems-agent config-dir

After aems-agent run, open AEMS in your browser, go to Settings → Storage, and pair the agent.

License

AGPL-3.0-or-later. See LICENSE.

Relicense note (v0.3.2, 2026-05-11): Versions ≤ 0.3.1 were licensed under MIT. From v0.3.2 the agent is AGPL-3.0-or-later because it links PyMuPDF (AGPL-3.0) in-process via aems-pdf-annotator. The MIT licence that previously applied to forks of v0.3.1 and earlier remains in effect for those versions.

Links

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

aems_agent-0.4.3.tar.gz (104.3 kB view details)

Uploaded Source

Built Distribution

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

aems_agent-0.4.3-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

Details for the file aems_agent-0.4.3.tar.gz.

File metadata

  • Download URL: aems_agent-0.4.3.tar.gz
  • Upload date:
  • Size: 104.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for aems_agent-0.4.3.tar.gz
Algorithm Hash digest
SHA256 b5feb84ea855ee0e261d32070891be23b332ca0612091b990bf3a07a620ce356
MD5 28ee50e4d742facece55947beff73385
BLAKE2b-256 35a879e3f61e193b90d6181d2186232311b449c9c30090f63d782a213b584892

See more details on using hashes here.

File details

Details for the file aems_agent-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: aems_agent-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for aems_agent-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 313771551c03836ad5bac4cdfe61da913d30d755a42d478a0e444bac6e2a63c5
MD5 d55be52f34e1b40e33f440f415ab6d4d
BLAKE2b-256 cf04197c30b784daa2f2484e56c71546f000ab30bbe36ac55fcacc9f7d10bcd7

See more details on using hashes here.

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