Skip to main content
Angreal Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Angreal Documentation
  2. /
  3. Reference
  4. /
  5. Python API Reference
  6. /
  7. Utility Functions
Edit page

Utility Functions

Angreal provides utility functions for common operations when working with projects and commands.

Overview

These utilities help with:

  • Project Structure - Locating the project root directory
  • Version Checking - Ensuring the right Angreal version is used

Key Functions

Function Description Documentation
get_root Get the root directory of the Angreal project API Reference
required_version Check for minimum required Angreal version API Reference

Example 

import angreal
import os

# Check for required version
angreal.required_version("2.0.0")

# Get the project root
root_dir = angreal.get_root()
templates_dir = os.path.join(root_dir, "templates")

print(f"Project root: {root_dir}")
print(f"Templates directory: {templates_dir}")