Skip to content

Commit

Permalink
docs: project docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jorwoods committed Oct 18, 2024
1 parent e623511 commit 2690492
Show file tree
Hide file tree
Showing 2 changed files with 570 additions and 0 deletions.
38 changes: 38 additions & 0 deletions tableauserverclient/models/project_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,44 @@


class ProjectItem:
"""
The project resources for Tableau are defined in the ProjectItem class. The
class corresponds to the project resources you can access using the Tableau
Server REST API.
Parameters
----------
name : str
Name of the project.
description : str
Description of the project.
content_permissions : str
Sets or shows the permissions for the content in the project. The
options are either LockedToProject, ManagedByOwner or
LockedToProjectWithoutNested.
parent_id : str
The id of the parent project. Use this option to create project
hierarchies. For information about managing projects, project
hierarchies, and permissions, see
https://help.tableau.com/current/server/en-us/projects.htm
samples : bool
Set to True to include sample workbooks and data sources in the
project. The default is False.
Attributes
----------
id : str
The unique identifier for the project.
owner_id : str
The unique identifier for the UserItem owner of the project.
"""

ERROR_MSG = "Project item must be populated with permissions first."

class ContentPermissions:
Expand Down
Loading

0 comments on commit 2690492

Please sign in to comment.