coretex.coretex.space.space.Space Class Reference

Inheritance diagram for coretex.coretex.space.space.Space:

Public Member Functions
Optional[Self]	createSpace (cls, str name, SpaceTask spaceTask, Optional[str] description=None)
bool	addProject (self, str name, Optional[str] description)
Public Member Functions inherited from coretex.coretex.space.base.BaseObject
bool	rename (self, str name)
bool	updateDescription (self, str description)

Detailed Description

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

Definition at line 26 of file space.py.

Member Function Documentation

addProject()

bool coretex.coretex.space.space.Space.addProject	(		self,
		str	name,
		Optional[str]	description
	)

    Adds new project to the space

    Parameters
    ----------
    name : str
project name
    description : Optional[str]
project description

    Returns
    -------
    bool -> True if the project was added. False if the project was not added

Definition at line 79 of file space.py.

    def addProject(self, name: str, description: Optional[str]) -> bool:
        """
            Adds new project to the space
 
            Parameters
            ----------
            name : str
                project name
            description : Optional[str]
                project description
 
            Returns
            -------
            bool -> True if the project was added. False if the project was not added
        """
 
        project = Project.createProject(name, self.id, description)
        if project is None:
            return False
 
        self.projects.append(project)
        return True

createSpace()

Optional[Self] coretex.coretex.space.space.Space.createSpace	(		cls,
		str	name,
		SpaceTask	spaceTask,
		Optional[str]	description = None
	)

    Creates a new space with the provided name and description

    Parameters
    ----------
    name : str
space name
    description : Optional[str]
space description

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

    Example
    -------
    >>> from coretex import Space, SpaceTask
    \b
    >>> dummySpace = Space.createSpace(
    name = "dummySpace",
    spaceTask = SpaceTask.other,
    description = "This is dummy Coretex Space"
)
    >>> if dummySpace is None:
    print("Failed to create space")

Definition at line 36 of file space.py.

    def createSpace(cls, name: str, spaceTask: SpaceTask, description: Optional[str] = None) -> Optional[Self]:
        """
            Creates a new space with the provided name and description
 
            Parameters
            ----------
            name : str
                space name
            description : Optional[str]
                space description
 
            Returns
            -------
            Optional[Self] -> The created space object
 
            Example
            -------
            >>> from coretex import Space, SpaceTask
            \b
            >>> dummySpace = Space.createSpace(
                    name = "dummySpace",
                    spaceTask = SpaceTask.other,
                    description = "This is dummy Coretex Space"
                )
            >>> if dummySpace is None:
                    print("Failed to create space")
        """
 
        return cls.create(parameters={
            "name": name,
            "project_task": spaceTask.value,
            "description": description
        })
 

---

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

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