<!-- Source: https://docs.squirro.com/en/latest/api/squirro_client.topic.ProjectGuideFilesMixin.html -->
# ProjectGuideFilesMixin

**`class ProjectGuideFilesMixin`**

Bases: [`object`](https://docs.python.org/3.11/library/functions.html#object)

Methods SummaryMethods Documentation

**`delete_guide_file(project_id)`**

Deletes the Project Guide file.

Parameters

`project_id` – ID of the project.

**`get_guide_file(project_id)`**

Gets the Project Guide file.

Parameters

`project_id` – ID of the project.

**`new_guide_file(project_id, guide_content)`**

Creates a new Project Guide file.

Parameters

- `project_id` – ID of the project.
- `guide_content` – Javascript content of the guide file as a
  string. The content is expected to be of type ‘str’, if guide_content
  of type ‘bytes’ is passed, we try to decode it using ‘utf-8’.

**`update_guide_file(project_id, guide_content)`**

Updates the content of Project Guide file.

Parameters

- `project_id` – ID of the project.
- `guide_content` – Javascript content of the guide file as a
  string.
