vent.helpers package

Submodules

vent.helpers.errors module

vent.helpers.errors.ErrorHandler(function)[source]

vent.helpers.logs module

vent.helpers.logs.Logger(name, **kargs)[source]

Create and return logger

vent.helpers.meta module

vent.helpers.meta.Containers(vent=True, running=True, exclude_labels=None)[source]

Get containers that are created, by default limit to vent containers that are running

vent.helpers.meta.Cpu()[source]

Get number of available CPUs

vent.helpers.meta.Dependencies(tools)[source]

Takes in a list of tools that are being updated and returns any tools that depend on linking to them

vent.helpers.meta.Docker()[source]

Get Docker setup information

vent.helpers.meta.DropLocation()[source]

Get the directory that file drop is watching

vent.helpers.meta.Gpu(pull=False)[source]

Check for support of GPUs, and return what’s available

vent.helpers.meta.GpuUsage(**kargs)[source]

Get the current GPU usage of available GPUs

vent.helpers.meta.Images(vent=True)[source]

Get images that are build, by default limit to vent images

vent.helpers.meta.Jobs()[source]

Get the number of jobs that are running and finished, and the number of total tools running and finished for those jobs

vent.helpers.meta.ParsedSections(file_val)[source]

Get the sections and options of a file returned as a dictionary

vent.helpers.meta.Services(core, vent=True, external=False, **kargs)[source]

Get services that have exposed ports, expects param core to be True or False based on which type of services to return, by default limit to vent containers and processes not running externally, if not limited by vent containers, then core is ignored.

vent.helpers.meta.System()[source]

Get system operating system

vent.helpers.meta.Timestamp()[source]

Get the current datetime in UTC

vent.helpers.meta.Tools(**kargs)[source]

Get tools that exist in the manifest

vent.helpers.meta.Uptime()[source]

Get the current uptime information

vent.helpers.meta.Version()[source]

Get Vent version

vent.helpers.paths module

class vent.helpers.paths.PathDirs(base_dir='/home/docs/.vent/', plugins_dir='plugins/', meta_dir='/home/docs/.vent')[source]

Bases: object

Global path directories for vent

static ensure_dir(path)[source]

Tries to create directory, if fails, checks if path already exists

static ensure_file(path)[source]

Checks if file exists, if fails, tries to create file

host_config()[source]

Ensure the host configuration file exists

static rel_path(name, available_tools)[source]

Extracts relative path to a tool (from the main cloned directory) out of available_tools based on the name it is given

Module contents