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.4.10.tar.gz (38.2 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.4.10-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brainframe_apps-0.4.10.tar.gz
  • Upload date:
  • Size: 38.2 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.4.10.tar.gz
Algorithm Hash digest
SHA256 c54785871bab9999f700255f213385b1d81f55be44a3a2975913aca70984cf4b
MD5 90ad656d6b0593bb243c0faf157966f7
BLAKE2b-256 c62626e758455e1d6c75db73149fa3ace5f203e61ba7d231444c1b37b9fafb70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for brainframe_apps-0.4.10-py3-none-any.whl
Algorithm Hash digest
SHA256 3e07fc5665632d7b0611c6bd049e9d6cec6390abebb4938c82e19dde39dde038
MD5 1e237d84498a4f31f3a482313404f61d
BLAKE2b-256 ac5a1c5469ffd868b1e5e3b3abf39d7b045f3e471ae3ab4a0113e6148acb7880

See more details on using hashes here.

Release history Release notifications | RSS feed

0.5.10

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

This release

0.4.10 This release

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