Skip to content

angee.project

Project-root discovery shared by Angee boot entrypoints.

has_project_contract

python
def has_project_contract(path: Path) -> bool

Return whether path declares an Angee project settings contract.

find_project_dir

python
def find_project_dir(*,
                     environ: Mapping[str, str] | None = None,
                     argv: Sequence[str] | None = None,
                     cwd: Path | str | None = None) -> Path | None

Return the project root when it can be discovered without failing.

Discovery is deliberately ordered: explicit ANGEE_PROJECT_DIR first, then the directory containing a manage.py entrypoint, then the nearest ancestor of the current working directory that carries settings.yaml or settings.py.

project_dir

python
def project_dir(*,
                environ: Mapping[str, str] | None = None,
                argv: Sequence[str] | None = None,
                cwd: Path | str | None = None) -> Path

Return the discovered project root, or fail with a boot error.

Released under the AGPL-3.0 License.