provenaclient

Table of Contents

  • Home
    • What is Provena Python Client?
    • Getting Started
    • Additional Resources
  • Quickstart
    • Initialising the provena client
    • Finding and searching items from the Registry
      • Fetching items from the Registry
      • Listing items in the Registry
      • Search for items
    • Registering
      • Registering datasets
      • Registering a model run
      • Registering other items via the Registry
  • Provena Client Library Workflow Guide and Example.
    • Client Configuration and Initialisation
    • Querying Datastore API.
    • Querying Provenance API.
      • Exploring Lineage
    • Lodging Model Runs & Querying with Job-API
    • Generating Reports
    • Querying Registry API.
      • General Registry Actions
  • Provenance integration with 3rd party libraries
    • Using Prov and rdflib python libraries
    • Visualisation using Graphviz
    • Advanced use case: Querying and joining graphs
  • CHANGELOG
    • v0.24.0 (2025-02-27)
      • Features
    • v0.23.0 (2024-12-20)
      • Features
    • v0.22.0 (2024-12-20)
      • Features
    • v0.21.0 (2024-11-07)
      • Features
    • v0.20.0 (2024-11-07)
      • Features
      • Unknown
    • v0.19.0 (2024-11-07)
      • Features
      • Unknown
    • v0.18.0 (2024-11-07)
      • Features
    • v0.17.0 (2024-11-07)
      • Features
      • Unknown
    • v0.16.0 (2024-11-03)
      • Features
      • Unknown
    • v0.15.0 (2024-11-03)
      • Documentation
      • Features
    • v0.14.0 (2024-08-29)
      • Features
    • v0.13.0 (2024-08-22)
      • Documentation
      • Features
    • v0.12.0 (2024-08-08)
      • Documentation
      • Features
      • Testing
      • Unknown
    • v0.11.2 (2024-07-21)
      • Bug Fixes
    • v0.11.1 (2024-07-19)
      • Bug Fixes
    • v0.11.0 (2024-07-12)
      • Features
    • v0.10.3 (2024-07-04)
      • Bug Fixes
    • v0.10.2 (2024-07-04)
      • Unknown
    • v0.10.1 (2024-07-04)
      • Bug Fixes
      • Continuous Integration
      • Unknown
    • v0.10.0 (2024-07-02)
      • Features
    • v0.9.0 (2024-06-28)
      • Documentation
      • Features
    • v0.8.0 (2024-06-21)
      • Features
      • Unknown
    • v0.7.0 (2024-06-21)
      • Features
      • Unknown
    • v0.6.0 (2024-06-18)
      • Features
      • Unknown
    • v0.5.0 (2024-06-18)
      • Features
    • v0.4.0 (2024-06-18)
      • Features
      • Unknown
    • v0.3.0 (2024-06-17)
      • Features
      • Unknown
    • v0.2.0 (2024-05-30)
      • Features
      • Unknown
    • v0.1.0 (2024-05-30)
      • Features
      • Unknown
    • v0.0.0 (2024-04-05)
      • Unknown
  • Contributing Guidelines
    • Usage
      • How to get started with Poetry
      • Using local .venv
      • My Poetry Installation is not being detected?
    • How to contribute to the Provena Python Client
      • 1) Initial Setup
      • 2) Codebase Layout and Contributing
      • 3) Create a New Branch
      • 4) Commit Message Conventions
      • 5) Develop and Commit
      • 6) Open a Pull Request (PR)
      • 7) Review and Squash Merge
      • 8) CI/CD Flow
    • Provena Client CI/CD and Release Process
    • Overview
    • Continuous Integration (CI)
    • Continuous Deployment (CD)
    • Semantic Versioning and Release Automation
      • Configuration in pyproject.toml [tool.semantic_release]
    • Release Process
      • Bumps the Version
      • Creates a New Tag
      • Publishes to PyPI
      • Uploads to GitHub Releases
      • Commits the New Version Number
    • Overall Summary
    • License
    • Credits
  • API Reference
    • provenaclient
      • Submodules
      • Attributes
      • Classes
      • Package Contents
provenaclient
  • API Reference
  • provenaclient
  • provenaclient.modules
  • provenaclient.modules.link
  • View page source

provenaclient.modules.link

Created Date: Friday May 31st 2024 +1000 Author: Peter Baker —– Last Modified: Friday May 31st 2024 9:50:26 am +1000 Modified By: Peter Baker —– Description: A L3 module which is setup to interact more nicely with the Username Person Link service. —– HISTORY: Date By Comments ———- — ———————————————————

18-06-2024 | Peter Baker | Initial ideas included but is not finished/ready. Blocked by Registry API functionality.

Classes

Link

This class interface just captures that the client has an instantiated auth

Module Contents

class provenaclient.modules.link.Link(auth: provenaclient.auth.manager.AuthManager, config: provenaclient.utils.config.Config, auth_client: provenaclient.clients.AuthClient)[source]

Bases: provenaclient.modules.module_helpers.ModuleService

This class interface just captures that the client has an instantiated auth manager which allows for helper functions abstracted for L3 clients.

_auth_client: provenaclient.clients.AuthClient
_auth
_config
async get_linked_person() → None[source]
async create_and_link_person() → None[source]
Previous Next

© Copyright 2025, Provena Development Team (CSIRO).

Built with Sphinx using a theme provided by Read the Docs.