The Valispace python API lets you access and update objects in your Valispace deployment.

To make use of the Valispace API you must have a valid login to any Valispace deployment. If you don't have an account, you can get a demo account at demo.vali.com. You can also find further documentation in docs.vali.com.

Install the Valispace python API with pip:

pip install valispace

Import valispace API module in a python script:

import valispace

And initialize with:

vali = vali.API()

At this step you will need to enter your Valispace url (e.g. https://demo.vali.com), username and password for authentication, or use the one line function:

Then use the Valispace API like this:

A dict of an entire data type:

all_valis = vali.all_data(type='vali')

The 'type' field can be: 'component', 'vali', 'textvali' or 'tag'

All Vali ids and names:

all_vali_names = vali.get_vali_names()

A Vali with all properties:

A matrix:

matrix = vali.get_matrix_str(57)

A Component with all properties:

A Project with all properties:

List of Valis with the specified arguments:

List of Components with the specified arguments:

List of Projects with the specified arguments:

A Vali formula:

vali.update_vali(50, formula=str(value + 1))

A matrix:

vali.update_matrix_formulas(57, [[2.1], [0.0], [0.0]])

vali.post_data(type='vali', data=json_object)

The input data should be a single JSON object. Check the examples:

import valispace
valispace = vali.API()

# -- Insert new Component --
vali.post_data(type='component', data="""{
        "name": "component_name",
        "description": "Insert description here",
        "parent": null,
        "project": 25,
        "tags": [30, 31, 32]
    }""")

# -- Insert new Vali --
vali.post_data(type='vali', data="""{
        "parent": 438,
        "shortname": "mass",
        "description": "",
        "unit": "kg",
        "formula": "5",
        "minimum": null,
        "maximum": null,
        "margin_minus": "0",
        "margin_plus": "0",
        "uses_default_formula": false,
        "reference": "",
        "type": null
    }""")

# -- Insert new Textvali --
vali.post_data(type='textvali', data="""{
        "shortname": "Message",
        "text": "Message text",
        "parent": 438
    }""")

# -- Insert new Tag --
vali.post_data(type='tag', data="""{
        "name": "white-tag",
        "color": "#FFFFFF"
    }""")

Notes:

• The "name" fields should never be repeated, this will result in a error in the REST API.
• The "valis" are automatically updated when new valis with this componenet id are inserted

Get all Vali ids and names:

all_vali_names = vali.get_vali_names()

Get a Vali with all properties:

a = vali.get_vali(50)
b = vali.get_vali_by_name("Fan.Mass")

Get the value of a Vali:

value = vali.get_vali_value(50)

Update a Vali formula:

vali.update_vali(50, formula=str(value + 1))

Get a matrix:

matrix = vali.get_matrix_str(57)

Update a matrix:

vali.update_matrix_formulas(57, [[2.1], [0.0], [0.0]])

• Valispace

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details.