Skip to main content

brainframe-apps

Python CLI tool for managing BrainFrame video analytics server via REST APIs.

Installation

pip install brainframe-apps

Usage

brainframe_apps <command> [options]

Commands

  • add-stream - Add video stream
  • delete-stream - Remove stream
  • list-stream - List streams
  • start-analyzing - Start stream analysis
  • stop-analyzing - Stop stream analysis
  • capsule-control - Manage AI capsules
  • alarm-control - Manage stream alarms
  • zone-control - Manage stream zones
  • identity-control - Manage identities
  • user-control - Manage users
  • license-control - Manage licenses
  • get-zone-statuses - Get zone status
  • process-image - Process a single image using the server's active capsules and configuration (per-stream or global)
  • load-settings - Load configuration
  • save-settings - Save configuration

Example

brainframe_apps add-stream --server-url http://localhost --stream-url rtsp://camera.url
brainframe_apps list-stream
brainframe_apps start-analyzing --stream-name "Camera 1"

# Uses the capsules enabled & configured on the server for stream 3:
brainframe_apps process-image --image-path frame.png --stream-id 3
# Omit --stream-id/--stream-url to use the global capsule configuration.

Help

brainframe_apps <command> --help

Download files

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

Source Distribution

brainframe_apps-0.5.10.tar.gz (38.4 kB view details)

Uploaded Source

Built Distribution

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

brainframe_apps-0.5.10-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file brainframe_apps-0.5.10.tar.gz.

File metadata

  • Download URL: brainframe_apps-0.5.10.tar.gz
  • Upload date:
  • Size: 38.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for brainframe_apps-0.5.10.tar.gz
Algorithm Hash digest
SHA256 279e8378ad097d703e2ec810584bfbca48cda00901d04e42e0dee081884bd651
MD5 4e5c489dda75076c9e89255127433de6
BLAKE2b-256 1b2102dd755e4e47d533771c1c9b14ba3866290ac89dba759b6d83b0835f2c4a

See more details on using hashes here.

File details

Details for the file brainframe_apps-0.5.10-py3-none-any.whl.

File metadata

File hashes

Hashes for brainframe_apps-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a36a6d8012e855b72269f86e4d6002337192ebfa1f1d035f427e92d0b8b284d2
MD5 f8796f5af37e6575d0dd96faa0ed88e8
BLAKE2b-256 6ccb8b2e61ae857dfb8b71a49ad1a7ca0dfa1b2099e3134ebd7d536f67d2bece

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.5.10 This release

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4.1

2 files

0.5.4

2 files

0.5.3

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6.1

2 files

0.4.6

2 files

0.4.5.5

2 files

0.4.5.4

2 files

0.4.5.3

2 files

0.4.3.5

2 files

0.3.20

2 files

0.3.19

2 files

0.3.18

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page