Skip to content

Getting started

Wheel locations

The build publishes wheels below this S3 prefix:

s3://ap-dame-prod/python_wheels/dame_tools/

Every successful main build publishes two wheels. For release 1.0.0, they are:

s3://ap-dame-prod/python_wheels/dame_tools/1.0.0/dame_tools-1.0.0-py3-none-any.whl
s3://ap-dame-prod/python_wheels/dame_tools/99.99.99/dame_tools-99.99.99-py3-none-any.whl

Versioned releases

The package version from pyproject.toml is published under its matching version directory and filename. These wheels provide stable, historical builds. Pin production notebooks and jobs to a release version so that a later build cannot change their environment unexpectedly.

Current-version alias (99.99.99)

99.99.99 is a moving alias for the latest successful main build. Its wheel is rebuilt with matching 99.99.99 package metadata and overwrites the previous alias. Use it when you intentionally want the newest build without updating a versioned path. Do not use it where reproducibility is required.

Install the selected wheel using the S3 access method supported by the target Databricks cluster or copy it to an accessible workspace or volume location first. Restart Python after installing or upgrading when required by the Databricks runtime.

Runtime assumptions

DAME Tools is primarily designed for Databricks. Depending on the module, it may expect:

  • an active Spark session available as spark;
  • Databricks utilities available as dbutils;
  • access to the relevant secrets, tables, and storage locations.

Individual API pages document additional requirements where they are present in the source docstrings.

Browse the documentation

The CircleCI build publishes this website to the team's private documentation location. Open it through the internal CloudFront URL to use module navigation and full-text search.