Skip to content

Projects

Grouping datasets and configurations into projects.

nimbusimage.projects.Project

A NimbusImage project.

dataset_ids property

List of dataset IDs in this project.

configuration_ids property

List of configuration (collection) IDs in this project.

publication_metadata property

Publication metadata (title, keywords, license, etc.).

zenodo property

Zenodo publication info, if any.

share(user_email_or_name, access='read')

Share this project, and every resource in it, with a user.

Requires ADMIN (owner) access on the project.

Parameters:

Name Type Description Default
user_email_or_name str

User's email or username.

required
access str

'read', 'write', 'admin', or 'remove'.

'read'

set_public(public=True)

Set whether this project and all its resources are public.

Requires ADMIN (owner) access on the project.

Resources in the project that the caller doesn't own are left unchanged.

Returns:

Type Description
dict

The server's summary: projectId, public and

dict

skipped (how many resources were left unchanged because

dict

the caller doesn't own them).

url()

URL for the project info page.

open()

Open the project page in the default browser.

Returns:

Type Description
str

The URL that was opened.