# Project

The Project collects together Definitions and their associated resources into a bundle for easy organisation of Hypervector tests around specific uses.

# Object

project = hypervector.Project.get("PROJECT_UUID")

After edits, you can ensure a local Project is up-to-date with:

project.refresh()

Endpoint

GET /v1/project/<project_uuid>

# Overview

{
  "project_uuid": "7239928c-5113-45dc-a6d2-247b03b06bb9",
  "project_name": "Example Project",
  "added": "Mon, 08 Mar 2021 22:14:17 GMT",
  "definitions": [...]
}

# Attributes

  • project_uuid: Identifier of Project
  • project_name: Name of Project
  • added: Datetime when Project was created
  • definitions: List of Definitions added to Project

# Methods

# All Projects

hypervector.Project.list()

Endpoint

GET /v1/projects

Retrieves list of all Projects associated with the provided API key

# New Project

hypervector.Project.new(project_name="Example project")

Endpoint

POST /v1/project/new

Creates new Project

# Parameters

  • project_name (Optional): Name of Project (default is "New project" if left blank)

# Delete Project

hypervector.Project.delete("PROJECT_UUID")

Endpoint

DELETE /v1/project/<project_uud>/delete

Deletes an existing Project