Projects

class frameioclient.Project(client)

add_collaborator(project_id, email)

Add Collaborator to a Project Collaborator.

Parameters:

• project_id (Union[str, UUID]) – The project id

• email (str) – Email user’s e-mail address

Example:

client.projects.add_collaborator(
  project_id="123",
  email="janedoe@frame.io",
)

create(team_id, **kwargs)

Create a project.

Parameters:

team_id (Union[str, UUID]) – The team id.

Kwargs:

kwargs (optional): additional request parameters.

Example:

client.projects.create(
  team_id="123",
  name="My Awesome Project"
)

download(project_id, destination_directory='downloads')

Download the provided project to disk.

Parameters:

• project_id (Union[str, UUID]) – The project’s id.

• destination_directory – Directory on disk that you want to download the project to.

Example:

client.projects.download(
  project_id="123",
  destination_directory="./downloads"
)

get(project_id)

Get an individual project

Parameters:

project_id (Union[str, UUID]) – The project’s id

Example:

client.project.get(
  project_id="123"
)

get_collaborators(project_id, **kwargs)

Get collaborators for a project

Parameters:

project_id (Union[str, UUID]) – The project’s id

Example:

client.projects.get_collaborators(
  project_id="123"
)

get_pending_collaborators(project_id, **kwargs)

Get pending collaborators for a project

Parameters:

project_id (Union[str, UUID]) – The project’s id

Example:

client.projects.get_pending_collaborators(
  project_id="123"
)

remove_collaborator(project_id, email)

Remove Collaborator from Project.

Parameters:

• project_id (Union[str, UUID]) – The Project ID.

• email (str) – The user’s e-mail address

Example:

client.projects.remove_collaborator(
  project_id="123",
  email="janedoe@frame.io"
)

tree(project_id, slim=False)

Fetch a tree representation of all files/folders in a project.

Parameters:

• project_id (Union[str, UUID]) – The project’s id

• slim (Optional[bool]) – If true, fetch only the minimum information for the following: filename, filesize, thumbnail, creator_id, inserted_at (date created), path (represented like a filesystem)

Example:

client.projects.get(
  project_id="123",
  slim=True
)