Framework for Python

Project Management

project_register()

Add a project to the registry in the global settings. Returns its id.

Usage

project_register(path: str | Path) -> int

Arguments

Name Type Description
path required str | Path

The project folder. It is expanded and resolved to an absolute path before it is stored.

Value

The project's id. A project already in the registry keeps its id and is not added again.