Install & Compatibility
Where this runs
tested against v0.32.0 · 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.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 24.4MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 2.5s · import 0.000s · 25MB
23MB installed
● package 23MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Table
✓ from amundsen_common.models.table import Table
✗ from amundsen_common.models.table import Table
This quickstart demonstrates how to import and instantiate core Amundsen Common data models, such as `Table`, and how to use common enumerations like `ResourceType`.
from amundsen_common.models.table import Table
from amundsen_common.entity.resource_type import ResourceType
# Create a Table object
table = Table(
database='my_database',
cluster='my_cluster',
schema_name='public',
name='users_data',
description='Contains user login and profile information.',
uri='my_database://my_cluster/public/users_data'
)
print(f"Created Table: {table.name} from {table.database}.{table.schema_name}")
print(f"Table URI: {table.uri}")
# Using a ResourceType enum
print(f"Resource Type for Table: {ResourceType.Table.name}")
print(f"Resource Type for Dashboard (value): {ResourceType.Dashboard.value}")
Debug
Known issues
gotchaAmundsen Common is part of a larger monorepo. While its versions are managed separately, significant changes often coincide with updates to other Amundsen services (metadata, search, frontend). Ensure compatibility when mixing versions of Amundsen components.fixAlways check the Amundsen release notes and recommended component versions for your specific Amundsen deployment to ensure compatibility across services.
affects: All versions
breakingSchema evolution in `amundsen-common` models (e.g., adding, removing, or renaming fields in `Table`, `Dashboard`, `User` objects) can break downstream services (Metadata, Search) or Databuilder jobs that rely on these models for data serialization/deserialization.fixReview the changelog for `amundsen-common` before upgrading. Update your Amundsen services, Databuilder extractors/loaders, and any custom code to accommodate schema changes. Test thoroughly in a staging environment.
affects: All major versions, and sometimes minor versions introducing new fields
gotcha`amundsen-common` provides abstract models and utilities. It does not include direct database connectivity or API clients. Users interact with these models through other Amundsen components or by implementing their own data access layers.fixUnderstand that `amundsen-common` defines the 'what' (data structures), not the 'how' (data persistence or retrieval). For integration with Amundsen services, refer to `amundsen-databuilder`, `amundsen-metadata`, or `amundsen-search` documentation.
affects: All versions
Upgrade
Version history
0.32.0latest on PyPI · released Mar 6, 2024
Audit
Dependencies
No dependency data recorded yet.