Skip to main content

OpenUBA CLI & SDK — install, run, and manage user behavior analytics models

Project description

OpenUBA

PyPI Python License

OpenUBA

The official CLI and Python SDK for OpenUBA — an open-source User Behavior Analytics platform.

Installation

pip install openuba

CLI Usage

# Install a model from the registry
openuba install model_sklearn

# List available models
openuba list

# Run a model
openuba run model_sklearn --data path/to/data.csv

# Show version
openuba version

Python SDK Usage

import openuba

# Configure the client (or set OPENUBA_API_URL env var)
openuba.configure(api_url="http://localhost:8000")

# List available models
models = openuba.list_models()
for model in models:
    print(model["name"], model["version"])

# Install a model
openuba.install("model_sklearn")

# Run a model
results = openuba.run("model_sklearn", data="path/to/data.csv")
print(results)

Configuration

The SDK can be configured via environment variables:

Variable Description Default
OPENUBA_API_URL OpenUBA API server URL http://localhost:8000
OPENUBA_TOKEN Authentication token None

Or programmatically:

import openuba
openuba.configure(api_url="http://your-server:8000", token="your-token")

License

GNU General Public License v3.0 — see LICENSE.

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

openuba-0.0.2.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

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

openuba-0.0.2-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file openuba-0.0.2.tar.gz.

File metadata

  • Download URL: openuba-0.0.2.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for openuba-0.0.2.tar.gz
Algorithm Hash digest
SHA256 1c8657ef5ed3da2ee582c79bb4ac361578e40df0e9cea998d80cbb94057fff21
MD5 b8b7d51cb05c686783439f1806db0ef3
BLAKE2b-256 c3fecc66febaa147c0057681e16f27a347b9f40a0941cf8474aee3ceea49ada3

See more details on using hashes here.

File details

Details for the file openuba-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: openuba-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for openuba-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 134c089d174a95aac674af2d169cda1935c79a0af03ca2abb823adcfd0202ebb
MD5 34aebec0930b24c595d376cbdb5a61fc
BLAKE2b-256 726bbf50d1cffe474adbdfe4936590406a21dd9816c8dcdeadb93328096d8207

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