Skip to content
PhotonForge

pda.load_project

load_project(
    name: 'str | None' = None,
    *,
    project_id: 'DocumentId | ReadOnlyURL | None' = None,
    version: 'str | None' = None,
    tag: 'str | None' = None,
    module_path: 'str' = './pflibs',
    set_config: 'bool' = True,
    create_template: 'bool' = False,
) -> 'Project'

Load one project by name or document reference.

Args

  • name: Project name to load.
  • project_id: Project document ID or reference URL.
  • version: Optional version filter.
  • tag: Optional tag filter.
  • module_path: Root path where modules are unpacked.
  • set_config: Whether to apply project config to PhotonForge.
  • create_template: Whether to create a starter module if absent.

Returns

Loaded project object.