Project

class tamr_client.UnknownProject(url, name, description=None)

A Tamr project of an unrecognized type

See https://docs.tamr.com/reference/the-project-object

Parameters

• url (URL) –

• name (str) –

• description (Optional[str]) –

tamr_client.project.by_resource_id(session, instance, id)

Get project by resource ID. Fetches project from Tamr server.

Parameters

• instance (Instance) – Tamr instance containing this dataset

• id (str) – Project ID

Raises

• project.NotFound – If no project could be found at the specified URL. Corresponds to a 404 HTTP error.

• requests.HTTPError – If any other HTTP error is encountered.

Return type

Union[CategorizationProject, MasteringProject, SchemaMappingProject, GoldenRecordsProject, UnknownProject]

tamr_client.project.by_name(session, instance, name)

Get project by name Fetches project from Tamr server.

Parameters

• instance (Instance) – Tamr instance containing this project

• name (str) – Project name

Raises

• project.NotFound – If no project could be found with that name.

• project.Ambiguous – If multiple targets match project name.

• requests.HTTPError – If any other HTTP error is encountered.

Return type

Union[CategorizationProject, MasteringProject, SchemaMappingProject, GoldenRecordsProject, UnknownProject]

tamr_client.project.get_all(session, instance, *, filter=None)

Get all projects from an instance

Parameters

• instance (Instance) – Tamr instance from which to get projects

• filter (Union[str, List[str], None]) – Filter expression, e.g. “externalId==wobbly” Multiple expressions can be passed as a list

Return type

Tuple[Union[CategorizationProject, MasteringProject, SchemaMappingProject, GoldenRecordsProject, UnknownProject], …]

Returns

The projects retrieved from the instance

Raises

requests.HTTPError – If an HTTP error is encountered.

tamr_client.project.attributes(session, project)

Get all attributes from a project

Parameters

project (Union[CategorizationProject, MasteringProject, SchemaMappingProject, GoldenRecordsProject, UnknownProject]) – Project containing the desired attributes

Return type

Tuple[Attribute, …]

Returns

The attributes for the specified project

Raises

requests.HTTPError – If an HTTP error is encountered.

Exceptions

class tamr_client.project.NotFound

Raised when referencing (e.g. updating or deleting) a project that does not exist on the server.

class tamr_client.project.Ambiguous

Raised when referencing a project by name that matches multiple possible targets.