Reference

Commands

usage: ivpm [-h]
            {activate,build,pkg-info,share,update,init,git-status,git-update,snapshot}
            ...

Positional Arguments

command

Possible choices: activate, build, pkg-info, share, update, init, git-status, git-update, snapshot

Sub-commands

activate

Starts a new shell that contains the activated python virtual environment

ivpm activate [-h] [-c C] [-p PROJECT_DIR] [args ...]

Positional Arguments

args

Named Arguments

-c

When specified, executes the specified string

-p, --project-dir

Specifies the project directory to use (default: cwd)

build

Build all sub-projects with an IVPM-supported build infrastructure (Python)

ivpm build [-h] [-d DEP_SET] [-g]

Named Arguments

-d, --dep-set

Uses dependencies from specified dep-set instead of ‘default-dev’

-g, --debug

Enables debug for native extensions

Default: False

pkg-info

Collect cflags for a listed set of packages

ivpm pkg-info [-h] [-k KIND] {paths,libdirs,libs,flags} pkgs [pkgs ...]

Positional Arguments

type

Possible choices: paths, libdirs, libs, flags

Specifies what info to query

pkgs

Named Arguments

-k, --kind

Specifies qualifiers on the type of info to query

share

Returns the ‘share’ directory, which includes cmake files, etc

ivpm share [-h] ...

Positional Arguments

path

update

Fetches packages specified in ivpm.yaml that have not already been loaded

ivpm update [-h] [-p PROJECT_DIR] [-d DEP_SET] [-a]

Named Arguments

-p, --project-dir

Specifies the project directory to use (default: cwd)

-d, --dep-set

Uses dependencies from specified dep-set instead of ‘default-dev’

-a, --anonymous-git

Clones git repositories in ‘anonymous’ mode

Default: False

init

Creates an initial ivpm.yaml file

ivpm init [-h] [-v VERSION] [-f] name

Positional Arguments

name

Named Arguments

-v, --version

Default: “0.0.1”

-f, --force

Default: False

git-status

Runs git status on any git packages

ivpm git-status [-h] [-p PROJECT_DIR]

Named Arguments

-p, -project-dir

git-update

Undocumented

ivpm git-update [-h] [-p PROJECT_DIR]

Named Arguments

-p, -project-dir

snapshot

Creates a snapshot of required packages

ivpm snapshot [-h] [-p PROJECT_DIR] [-r] snapshot_dir

Positional Arguments

snapshot_dir

Specifies the directory where the snapshot will be created

Named Arguments

-p, -project-dir

-r, --rls-deps

Uses release deps from project root instead of dev deps

Default: False

YAML File Format

Package Definition

type	object
properties
name	Name of the package
	type	string
dep-sets	List of named depdendency sets
	type	array
	items	Named package-dependency set

Named package-dependency set

type	object
properties
name	Dependency-set identifier. ‘default’ and ‘default-dev’ are builtin names
	type	string
deps	Package dependencies
	type	array
	items	Package Dependency specification

Package Dependency specification

type	object
properties
required	[‘name’]
name	Package identifier
	type	string
url	URL from which to obtain the dependency. Used for all execpt ‘pypi’
	type	string
src	Specifies the source type. Most of the time auto-detect works
	type	string
	oneOf	URL points to a Git repository
		const	git
		URL points to a .jar file. IVPM will not expand
		const	jar
		URL points to a gzip-compressed TAR file. IVPM will expand
		const	tgz
		URL points to a xz-compressed TAR File. IVPM will expand
		const	txz
		URL points to a zip file. IPVM will expand
		const	zip
		Dependency name is a PyPi package to be installed with pip
		const	pypi
type	Specifies package type. Most of the time auto-detect works
	type	string
	oneOf	Data package. IVPM will not attempt to interpret
		const	raw
		Python package that IVPM will install into the venv
		const	python
version	Version-specification string for Python packages from PyPi
	type	string
anonymous	Clone using anonymous (non-PAT) Git
	type	boolean
branch	Git branch to checkout
	type	string
tag	Git tag to checkout
	type	string
commit	Git commit to checkout
	type	string
deps	When set to ‘skip’, sub-dependencies will not be loaded
	type	string
depth	Git clone depth
	type	integer
dep-set	Assuming the target is an IVPM package, Specifies the named dep-set to use
	type	string