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.4.tar.gz (104.7 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.4-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aems_agent-0.4.4.tar.gz
  • Upload date:
  • Size: 104.7 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.4.tar.gz
Algorithm Hash digest
SHA256 7e629f9703bfce32223cfca90284a65b580e61a6e9cabebc7ce607a4164e5768
MD5 86f141248cdfd7031d3735676367411e
BLAKE2b-256 8acf6da0ff08d051619308b9cfac0cf7744cef217f6a32dee3f6603ddde6aa7b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aems_agent-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 61.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ec70d0a55e93156df2061b351ad723fb227a7428f19e0e5792035b7e46debd35
MD5 fa8699dcbbcecadf15ec206a37507078
BLAKE2b-256 bb8269fc7710693d12603a19b5c1823b97d1a15c9a8a54a3d0121c6a37f58a17

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