Registry / web-framework / assemblyline-ui

assemblyline-ui

library4.7.3.1pypypiunverified

Assemblyline 4 - API and Socket IO server. Version 4.7.3.1 is the latest. The project is under active development (pre-1.0), with frequent releases. Part of the Assemblyline suite by the Canadian Centre for Cyber Security.

web-framework http-networking data

pip install assemblyline-ui

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ASSEMBLYLINE-UI

assemblyline-ui

web-frameworkpythonv4.7.3.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AssemblylineAPI

✓ from assemblyline_ui.api import AssemblylineAPI

✗ from assemblyline_ui.api import AssemblylineAPI

Initialize the API client using Assemblyline's forge configuration.

from assemblyline_ui.api import AssemblylineAPI from assemblyline.common import forge # Initialize using a configuration dict config = forge.get_config() api = AssemblylineAPI(config) # Example: list submissions submissions = api.list_submissions() print(submissions)

Debug

Known issues

breakingConfiguration format changed between v4.0 and v4.1. The 'forge.get_config()' no longer accepts a file path parameter; it reads from environment variables or a default config.

fix

Use 'forge.get_config()' without arguments, and set ASSEMBLYLINE_CONFIG environment variable or place config in standard location.

affects: 4.0.x -> 4.1.x

deprecatedThe 'from assemblyline_ui import api as api_module' import path is deprecated. Use direct submodule imports.

fix

Replace with 'from assemblyline_ui.api import AssemblylineAPI'

affects: <4.7

gotchaWhen running tests, ensure the socket.io server is not initialized unless explicitly needed, as it may block the event loop.

fix

Import SocketIOServer only inside async functions or use conditionals.

affects: all

Upgrade

Version history

4.7.3.1latest on PyPI · released Apr 23, 2026

Audit

Dependencies

assemblylinerequiredCore API client and shared models

assemblyline-socketio-clientrequiredReal-time event streaming

Agent activity

38 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/CybercentreCanada/assemblyline-ui ↗

packagehttps://pypi.org/project/assemblyline-ui/ ↗

homepagehttps://cyber.gc.ca/assemblyline ↗