create_project Namespace Reference

Functions
	create_project (name, destination=DEST_ROOT)

Variables
	TEMPLATE_ROOT = os.path.join("RenderingEngine", "Scripts", "Templates")
	DEST_ROOT = os.path.join("UserApplications")
int	destination = 3 else DEST_ROOT

Function Documentation

create_project()

create_project.create_project	(		name,
			destination = DEST_ROOT
	)

@brief Create a new Rendering Engine user application.

Generates the project folder structure and copies template files.
Projects created in the default UserApplications directory are
automatically registered in UserApplications/CMakeLists.txt.

@param name         Name of the project to create.
@param destination  Directory in which the project will be created.

Definition at line 65 of file create_project.py.

def create_project(name, destination=DEST_ROOT):
    """
    @brief Create a new Rendering Engine user application.
 
    Generates the project folder structure and copies template files.
    Projects created in the default UserApplications directory are
    automatically registered in UserApplications/CMakeLists.txt.
 
    @param name         Name of the project to create.
    @param destination  Directory in which the project will be created.
    """
    destination = os.path.abspath(destination)
    default_destination = os.path.abspath(DEST_ROOT)
    project_dir = os.path.join(destination, name)
 
    if os.path.exists(project_dir):
        print(f"Error: Project '{name}' already exists at '{project_dir}'.")
        return
 
    os.makedirs(project_dir)
    copy_template(TEMPLATE_ROOT, project_dir, name)
 
    if destination == default_destination:
        file_path = os.path.join(default_destination, "CMakeLists.txt")
        cmake_add_project = "\n" + "add_subdirectory(" + name + ")"
 
        with open(file_path, "a") as cmake_file:
            cmake_file.write(cmake_add_project)
    else:
        if not register_project(project_dir):
            print(
                f"Warning: Project '{name}' was created successfully, "
                "but could not be registered."
            )
            return
 
    print(f"Created new project at {project_dir}")
 

Variable Documentation

DEST_ROOT

create_project.DEST_ROOT = os.path.join("UserApplications")

Definition at line 35 of file create_project.py.

destination

int create_project.destination = 3 else DEST_ROOT

Definition at line 107 of file create_project.py.

TEMPLATE_ROOT

create_project.TEMPLATE_ROOT = os.path.join("RenderingEngine", "Scripts", "Templates")

Definition at line 34 of file create_project.py.