Python SDK CRIPT Script Demo

[nh916]

small CRIPT Python SDK script to show some of its more used features

this script shows the Create, Read, and Update feature of the CRIPT Python SDK

import json
import os
import uuid

import cript

# get sensitive data from machines environment variables
cript_host = os.getenv("CRIPT_HOST")
cript_api_token = os.getenv("CRIPT_TOKEN")
cript_storage_token = os.getenv("CRIPT_STORAGE_TOKEN")

with cript.API(host=cript_host, api_token=cript_api_token, storage_token=cript_storage_token) as api:
    # ============= Create all needed nodes =============
    my_project_node = cript.Project(name=f"my_Project_{uuid.uuid4().hex}")  # putting UUID in the name to not have any naming clashes while in demo
    my_collection_node = cript.Collection(name="my collection name")
    my_experiment_node = cript.Experiment(name="my experiment name")
    my_computation_node = cript.Computation(name="my computation name", type="analysis")
    my_software_node = cript.Software(name="SOMA", version="0.7.0", source="https://gitlab.com/InnocentBug/SOMA")
    my_software_configuration = cript.SoftwareConfiguration(software=my_software_node)
    my_algorithm_node = cript.Algorithm(key="mc_barostat", type="barostat")
    my_parameter_node = cript.Parameter(key="update_frequency", value=1000.0, unit="1/second")

    #  ============= Assemble nodes together =============
    my_project_node.collection = [my_collection_node]
    my_project_node.collection[0].experiment = [my_experiment_node]
    my_project_node.collection[0].experiment[0].computation = [my_computation_node]
    my_project_node.collection[0].experiment[0].computation[0].software_configuration = [my_software_configuration]
    my_project_node.collection[0].experiment[0].computation[0].software_configuration[0].algorithm = [my_algorithm_node]

    print("Project JSON before sending to API")
    print(my_project_node.json)

    # save project node
    print("saving project...")
    api.save(my_project_node)

    print("project saved successfully!")

    print("Getting project from API...")
    my_paginator = api.search(
        node_type=cript.Project,
        search_mode=cript.SearchModes.EXACT_NAME,
        value_to_search=my_project_node.name,
    )

    # get API JSON response from paginator object
    api_response = my_paginator.current_page_results[0]

    print(api_response)

    # update collection notes
    my_project_node.collection[0].notes = "my new updated notes"

    print("Update project...")
    api.save(project=my_project_node)

    print("Get updated project from API...")
    my_paginator = api.search(
        node_type=cript.Project,
        search_mode=cript.SearchModes.EXACT_NAME,
        value_to_search=my_project_node.name,
    )

    # get API JSON response from paginator object
    api_response = my_paginator.current_page_results[0]

    print(api_response)

    print("Get updated project from API and deserialize it into a Project node")
    my_project_node_from_api = cript.load_nodes_from_json(
        json.dumps(my_paginator.current_page_results[0])
    )

    print("show deserialized node from API")
    print(my_project_node_from_api.json)

[nh916]

we can also output the Project URL for the user to see their project in the frontend with

print(f"https://www.mycriptapp.org/Project/{my_project_node.uuid}/")