Install & Compatibility
Where this runs
tested against v0.11.3 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 2.184s · 76.1MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 6.4s · import 1.390s · 74MB
75MB installed
● package 75MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DataformClient
✓ from google.cloud.dataform_v1beta1 import DataformClient
✗ from google.cloud import dataform_v1beta
This quickstart initializes a Dataform client and lists all Dataform repositories within a specified Google Cloud project and location. Ensure your `GOOGLE_CLOUD_PROJECT` environment variable is set or replace 'your-project-id' with your actual project ID, and set the correct location. Authentication is handled automatically via Application Default Credentials (ADC).
import os
from google.cloud import dataform_v1beta
# Set your Google Cloud Project ID and Location
# For example, 'my-project-id' and 'us-central1'
project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', 'your-project-id')
location = 'us-central1' # Replace with your Dataform repository location
def list_dataform_repositories(project_id: str, location: str):
"""Lists Dataform repositories in a given project and location."""
client = dataform_v1beta.DataformClient()
parent = f"projects/{project_id}/locations/{location}"
print(f"Listing Dataform repositories in {parent}:")
try:
for repository in client.list_repositories(parent=parent):
print(f"- Repository: {repository.name}")
except Exception as e:
print(f"Error listing repositories: {e}")
print("Please ensure the Dataform API is enabled and your account has the necessary permissions.")
if __name__ == "__main__":
list_dataform_repositories(project_id, location)
Debug
Known issues
breakingAs of January 19, 2026, Dataform workflows, BigQuery notebooks, pipelines, and data preparations enforce strict act-as mode at the project level. This requires using custom service accounts instead of the default Dataform service agent across all repositories and granting the Service Account User role (`roles/iam.serviceAccountUser`) to the default Dataform service agent and relevant principals to avoid failures.fixMigrate to using custom service accounts for Dataform repositories and ensure `roles/iam.serviceAccountUser` is granted to them. Refer to Google Cloud documentation on 'Use strict act-as mode' and 'Verify act-as permissions'.
affects: >= 0.9.0
deprecatedLegacy Dataform was deprecated on February 26, 2024. Projects running on legacy Dataform cannot be accessed after this date.fixMigrate any existing legacy Dataform projects to Dataform in Google Cloud Platform. Refer to the official migration guide.
affects: N/A (affects old Dataform product, not this client library directly)
gotchaThe `google-cloud-dataform` library is currently in `0.x.x` version series, indicating that its API surface might still undergo backward-incompatible changes between minor versions (e.g., 0.8.0 to 0.9.0). While Google aims for stability, pre-1.0 releases do not strictly adhere to semantic versioning guarantees.fixPin your dependency to specific patch versions (e.g., `google-cloud-dataform==0.9.0`) to prevent unexpected breakage during upgrades, and thoroughly test minor version updates.
affects: < 1.0.0
gotchaThe library's internal logging events (occurrence, level, content) may be refined without being flagged as breaking changes. Avoid depending on the immutability of these logging events.fixDo not build critical system logic solely dependent on the exact format or content of library-generated log messages. Configure standard Python logging handlers to capture logs at appropriate levels.
affects: All versions
breakingPython versions 3.6 and below are no longer supported by Google Cloud client libraries, including `google-cloud-dataform`.fixUpgrade your Python environment to version 3.7 or higher. All current active and maintenance versions of Python (>=3.7) are compatible.
affects: <= 3.6
breakingThe required `google-cloud-dataform` client library, or the specific version containing the `dataform_v1beta` submodule, may not be installed or is incompatible with the import statement. Importing client components directly from `google.cloud` (e.g., `from google.cloud import dataform_v1beta`) depends on the individual client library being correctly installed and compatible.fixEnsure the `google-cloud-dataform` library is installed using `pip install google-cloud-dataform`. If already installed, ensure it is up-to-date or compatible with the desired API version (`dataform_v1beta`). Verify installed packages with `pip freeze` and consult the library's documentation or changelog for module availability and import paths.
affects: All versions
gotchaAttempting to import `dataform_v1beta` directly from `google.cloud` (e.g., `from google.cloud import dataform_v1beta`) will result in an `ImportError`. The Dataform v1beta client is typically found within its own subpackage.fixUse `from google.cloud.dataform_v1beta import DataformClient` to import the Dataform v1beta client, or `from google.cloud import dataform` for the stable client if that is desired, followed by `dataform.DataformClient`.
affects: All versions
Upgrade
Version history
0.11.3latest on PyPI · released Aug 24, 2026
Audit
Dependencies
google-api-corerequiredCore library for Google Cloud API clients.
google-authrequiredHandles authentication with Google Cloud services.
proto-plusrequiredProvides Pythonic wrappers around Protocol Buffer messages.