coretex.coretex.space.project.Project Class Reference

Inheritance diagram for coretex.coretex.space.project.Project:

Public Member Functions
Optional[Self]	createProject (cls, str name, int spaceId, Optional[str] description=None)
Public Member Functions inherited from coretex.coretex.space.base.BaseObject
bool	rename (self, str name)
bool	updateDescription (self, str description)

Detailed Description

    Represents the project entity from Coretex.ai\n
    Contains properties that describe the project

Definition at line 25 of file project.py.

Member Function Documentation

createProject()

Optional[Self] coretex.coretex.space.project.Project.createProject	(		cls,
		str	name,
		int	spaceId,
		Optional[str]	description = None
	)

    Creates a new project with the provided name and description
    Project is added to the space with provided space id

    Parameters
    ----------
    name : str
project name
    spaceId : int
space id the project belongs to
    description : Optional[str]
project description

    Returns
    -------
    Optional[Self] -> The created project object

    Example
    -------
    >>> from coretex import Project
    \b
    >>> dummyProject = Project.createProject(
    name = "dummyProject",
    spaceId = 23,
    description = "This is dummy project"
)
    >>> if dummyProject is None:
    print("Failed to create project")

Definition at line 43 of file project.py.

    def createProject(cls, name: str, spaceId: int, description: Optional[str]=None) -> Optional[Self]:
        """
            Creates a new project with the provided name and description
            Project is added to the space with provided space id
 
            Parameters
            ----------
            name : str
                project name
            spaceId : int
                space id the project belongs to
            description : Optional[str]
                project description
 
            Returns
            -------
            Optional[Self] -> The created project object
 
            Example
            -------
            >>> from coretex import Project
            \b
            >>> dummyProject = Project.createProject(
                    name = "dummyProject",
                    spaceId = 23,
                    description = "This is dummy project"
                )
            >>> if dummyProject is None:
                    print("Failed to create project")
        """
 
        return cls.create(parameters={
            "name": name,
            "parent_id": spaceId,
            "description": description
        })

---

The documentation for this class was generated from the following file:

• src/coretex/coretex/space/project.py