Framework for Python

Project Management

project_create()

Create a Python project from a resolved spec.

Usage

project_create(
    spec: Mapping[str, Any],
    location: str | Path,
    *,
    headless: bool = False,
) -> Path

Arguments

Name Type Default Description
spec required Mapping[str, Any]

A resolved spec, from spec_resolve().

location required str | Path

The project folder. It must not exist, except in headless mode, where it may be a fresh checkout holding only .git, .github, .framework, README.md, and LICENSE.

headless bool False

For automation (the framework.pub GitHub Action): no git initialization, no registry entry, and no files under .github/workflows/.

Value

The project folder.