Studies

Client.export_chapter(study_id, chapter_id, clocks=True, comments=True, variations=True)

Export one study chapter

Parameters

  • study_id (str) – The study ID (8 characters)

  • chapter_id (str) – The chapter ID (8 characters)

  • clocks (Optional[bool]) – When available, include clock comments in the PGN moves

  • comments (Optional[bool]) – When available, include analysis and annotator comments in the PGN moves

  • variations (Optional[bool]) – When available, include non-mainline moves

Returns

A string with PGN data of one study chapter

Return type

str


Client.export_chapters(study_id, clocks=True, comments=True, variations=True)

Export all the chapters of a study

Parameters

  • study_id (str) – The study ID (8 characters)

  • clocks (Optional[bool]) – When available, include clock comments in the PGN moves

  • comments (Optional[bool]) – When available, include analysis and annotator comments in the PGN moves

  • variations (Optional[bool]) – When available, include non-mainline moves

Returns

A string with PGN data of all the chapters of a study

Return type

str


Client.export_studies(user, clocks=True, comments=True, variations=True)

Export all the studies of a user

Parameters

  • user (str) – The user whose studies to export

  • clocks (Optional[bool]) – When available, include clock comments in the PGN moves

  • comments (Optional[bool]) – When available, include analysis and annotator comments in the PGN moves

  • variations (Optional[bool]) – When available, include non-mainline moves

Returns

A string with PGN data of all the studies of a user

Return type

str