Skip to content

API reference

This reference documents the supported Python interface for dame-tools. Use the navigation or search to find a module, class, function, or method by name. Search accepts a full Python path, an individual name such as create_job, or words from an entry's docstring, such as scheduled Databricks job.

What each entry contains

Depending on the available type hints and docstring, an API entry can include:

  • its callable signature and default values;
  • a description of its behavior;
  • parameters and expected input structures;
  • return values and DataFrame schemas;
  • raised exceptions and validation behavior;
  • side effects and Databricks-specific assumptions.

Private methods, constructors such as __init__, and class methods are included beneath their class in the page contents. Imported helpers and full source-code listings are excluded.

Runtime assumptions

Most modules are designed for Databricks and can assume:

  • an active Spark session available as spark;
  • Databricks utilities available as dbutils;
  • access to the required secrets, tables, and S3 locations;
  • Spark DataFrames for distributed processing.

Some utilities return or accept pandas DataFrames. Use those APIs only when the data is known to fit safely in driver memory.

Versioning

Versioned wheels, such as 1.0.0, provide reproducible releases. The 99.99.99 wheel is a moving alias for the latest successful main build. See Getting started for exact S3 paths and installation guidance.

Contributors

The main contributors and maintainers are: