Package index • pyprojroot

Root Finding

Locate the root directory of a Python project.

find_python_root(): Find the root of a Python project
python_root_file(): Build a path within a Python project root
is_here: Sentinel file criterion

Project Detection

Detect the type of Python project based on configuration files and layout conventions.

detect_python_project(): Detect the type and root of a Python project
is_python_project: Any Python project criterion
is_python_package: Python package criterion
is_pyproject: Generic pyproject.toml criterion

Package Manager Criteria

Criteria functions for identifying projects managed by specific tools.

is_uv_project: uv project criterion
is_poetry_project: Poetry project criterion
is_pipenv_project: Pipenv project criterion
is_pdm_project: Python Dependency Manager (PDM) project criterion
is_pip_project: pip / requirements.txt criterion
is_conda_project: Conda project criterion

Layout Criteria

Criteria functions for identifying project source layout conventions.

is_src_layout: src layout criterion
is_flat_layout: Flat layout criterion