Research Folders¶

Methods for managing research folders (/api/folders).

pyclann.client.FoldersClient ¶

FoldersClient(http: _HttpSession)

Methods for the /api/folders resource.

list(*, created_by: str | None = None) -> builtins.list[ResearchFolder]

Return research folders, ordered by name.

Parameters:

Name	Type	Description	Default
`created_by`	`str \| None`	Filter by creator username.	`None`

Returns:

Type	Description
`list[ResearchFolder]`	List of :class:`~pyclann.models.ResearchFolder` objects.

Raises:

Type	Description
`ClannAuthError`	If not authenticated.

create(name: str, created_by: str) -> ResearchFolder

Create a research folder.

Parameters:

Name	Type	Description	Default
`name`	`str`	Folder name.	required
`created_by`	`str`	Username of the creator.	required

Returns:

Type	Description
`ResearchFolder`	The newly created :class:`~pyclann.models.ResearchFolder`.

Raises:

Type	Description
`ClannAuthError`	If not authenticated.

rename(folder_id: str, name: str) -> ResearchFolder

Rename a research folder.

Parameters:

Name	Type	Description	Default
`folder_id`	`str`	Full record ID (`"research_folder:01jd4a8xyz"`) or bare ULID.	required
`name`	`str`	New folder name.	required

Returns:

Type	Description
`ResearchFolder`	The updated :class:`~pyclann.models.ResearchFolder`.

Raises:

Type	Description
`ClannNotFoundError`	If the folder does not exist.
`ClannAuthError`	If not authenticated.

delete(folder_id: str) -> None

Delete a folder. Notes inside are unfiled but not deleted.

Parameters:

Name	Type	Description	Default
`folder_id`	`str`	Full record ID or bare ULID.	required

Raises:

Type	Description
`ClannNotFoundError`	If the folder does not exist.
`ClannAuthError`	If not authenticated.