CHANGELOG

v0.22.0 (2024-12-20)

Features

  • feat: JIRA 1818 - Adding Types to Lineage Response for Special Queries in Prov-API. (#38) (926154b)

v0.21.0 (2024-11-07)

Features

  • feat: forced release - attestations false this is causing failure in CD job as well. (01ff4a4)

v0.20.0 (2024-11-07)

Features

  • feat: forced release due to issue with github pypi action package from development team. (dfeac9e)

Unknown

  • Merge branch ‘main’ of github.com:provena/provena-python-client into main (8ed7615)

v0.19.0 (2024-11-07)

Features

  • feat: forced release - downgrading to pypi action 1.11 due to known issue caused by action development team. (2412ae5)

  • feat: Forced release - Updating CD job with correct PyPI tag. (5b2ca79)

  • feat: forced release. (e36d124)

Unknown

  • Merge branch ‘main’ of github.com:provena/provena-python-client into main (d6beab4)

v0.18.0 (2024-11-07)

Features

  • feat: Force updating - Update to latest semantic versioning and github release gh action. (9a4f842)

  • feat: Forced push - Reverting back to 8.3.0 (bc178ea)

v0.17.0 (2024-11-07)

Features

  • feat: Forcing release with stable gh action version tag. (4f30d67)

  • feat: trying newer publish (6c2cd03)

Unknown

  • Changing tag to use the most stable version. (18f197b)

v0.16.0 (2024-11-03)

Features

Unknown

  • Update action.yml

Testing incremented version of semantic release (4c4f462)

v0.15.0 (2024-11-03)

Documentation

  • docs: Creating Software Architecture Documentation and Added Sequence Diagram (#35)

Co-authored-by: Ross ross.petridis@csiro.au (cc3aa83)

  • docs: Added a “how to contribute” section in contributing doc and updated a few other things. (#34) (47a7e6c)

Features

  • feat: adding model run update to prov client (#36)

Signed-off-by: Peter Baker peter.baker122@csiro.au (b57cf71)

v0.14.0 (2024-08-29)

Features

  • feat: Completed downloading specific files/directory from dataset. (#33)

Co-authored-by: Ross ross.petridis@csiro.au (d45906d)

v0.13.0 (2024-08-22)

Documentation

  • docs: Fixed missing link on docs home page and corrected contributing guide… (#31) (946729e)

  • docs: Docs-1734 - Completed Repo Level Docs + Created new Landing Page for Client docs. (#30)

Completed Repo Root Level Documentation and created a new landing page for client documentation.

Co-authored-by: Ross ross.petridis@csiro.au (d1f71ef)

Features

  • feat: JIRA-1730 interactive dataset class in datastore module. (#32)

Added interactive dataset session functionality within the datastore module. Allows users to contionusly perform operations on a specific dataset, without having to keep re-supplying the dataset ID. (efc8795)

v0.12.0 (2024-08-08)

Documentation

  • docs: Docs 1708 setup client documentation (#29)

Setup documentation of client library in CI/CD Pipeline. CI builds docs, and CD publishes docs to github pages using ghp-import tool. (673dc6a)

  • docs: Docs 1708 setup client documentation (#24) (3b09394)

Features

  • feat: Forcing new release to access “requests” dependency. (3595042)

Testing

  • test: JIRA-1706: Tests 1706 integration tests (#23)

Completed Integration Tests + Created a Guide for Client Library tests.

Co-authored-by: Ross ross.petridis@csiro.au (66d96fa)

Unknown

  • Added secerts capture on push to main workflow for CI/CD. (2d3e8c9)

v0.11.2 (2024-07-21)

Bug Fixes

  • fix: Increasing httpx timeout to 30s global to mirror api gateway (#28) (98f325e)

v0.11.1 (2024-07-19)

Bug Fixes

  • fix: (auth-api client) user link look up - Issue #26 (#27) (271df3c)

v0.11.0 (2024-07-12)

Features

  • feat: Implemented L3 general method to get count of all items in registry. (#25) (096e037)

v0.10.3 (2024-07-04)

Bug Fixes

  • fix: forcing rebuild due to trusted publisher issue (3575b29)

v0.10.2 (2024-07-04)

Unknown

  • Merge branch ‘main’ of github.com:provena/provena-python-client into main (bda5606)

v0.10.1 (2024-07-04)

Bug Fixes

  • fix: forcing rebuild due to trusted publisher issue (7136675)

  • fix: Adding more py.typed markers (ff3e029)

Continuous Integration

  • ci: Fixing missing fetch depth = 0 and documenting (2302b7a)

  • ci: Fixing missing pass through for CD action (#22) (0896a36)

  • ci: Modularisation of CI/CD into actions to clearly separate trigger files (#21) (e1f4664)

Unknown

  • Merge branches ‘modular-actions-setup’ and ‘main’ of github.com:provena/provena-python-client into main (fee9615)

  • Fixing not using new input (45cc98c)

  • Merge branch ‘main’ into modular-actions-setup (36bfd12)

  • Pass through GITHUB_TOKEN from parent workflow (296eba3)

  • Removing test file (eae09bf)

  • Removing fetch depth zero to be safe (88fcdba)

  • Cloning repo before all actions (69f2309)

  • Update including test (e16f672)

  • fix:Update auth’s init.py (#20) (b555bd1)

v0.10.0 (2024-07-02)

Features

  • feat: improving dependency resolution and adding interfaces (#19) (d941a8c)

v0.9.0 (2024-06-28)

Documentation

  • docs: Completed Release Process Documentation. (#17) (2c8f20f)

Features

  • feat: JIRA-1710 (minor) completing registry api L2 and L3 interfaces with support for admin, general and other endpoints. (#18) (cd2b4e9)

v0.8.0 (2024-06-21)

Features

  • feat: Updated pyproject.toml settings to increment project versioning. (b61fe49)

Unknown

  • Merge branch ‘main’ of github.com:provena/provena-python-client into main (cd6ad90)

v0.7.0 (2024-06-21)

Features

  • feat: changed semantic release settings to increment project version. (1899df9)

  • feat: Testing version increment. (bff0daf)

Unknown

  • Included pytest-asycnio missing dependency. (8d4442a)

  • Completed Unit Testing for L1 & L2 Layers.

  • Completed L1 layer testing mocked with various http methods and status codes.

  • Completed L1 layer testing, created fixtures and also added small set of integration tests for L1 layer.

  • Completed L2 Layer Testing, need further review on missing tests and what can be improved.

  • Fixed some tests that were failing due to wrong HTTP type or incorrect use of final url.

  • Completed unit tests with doc string and exception chain identification.

  • Updated CI-CD script to run only once.

  • Added header commenting to files.

  • Updated lock file.

  • mypy testing. Does not seem to be an issue on my end.

  • Included pytest-httpx dependency.

  • change mocked auth service to use base class methods only and updated robustness of exception chaining function. (8c52602)

  • Refactoring auth interface (#13)

Small refactor of config instantiation (7d6dea5)

v0.6.0 (2024-06-18)

Features

  • feat: forcing update to 0.6.0 (91e2879)

Unknown

  • Adding dataset L3 level IO functions + class header files (#14)

  • Download method completed in sub module to isolate s3 functionality - added sub module sub folder

  • Implementing the upload method and improving variable names

  • Adding file header and configuration for the psioniq extensions

  • Class header documentation and other clean up

  • Fixing lock files

  • Adding list all files (b7a4388)

v0.5.0 (2024-06-18)

Features

  • feat: forcing another attempt (5bb0e49)

v0.4.0 (2024-06-18)

Features

  • feat: Updating pyproject to promote new release (34b71da)

Unknown

v0.3.0 (2024-06-17)

Features

  • feat(major): First major release (30ac329)

Unknown

  • Removing union pipes (#12) (ea83080)

  • Jira-1670(Minor): Offline token auth flow (#11)

Implements offline token authentication method (0a6f0b3)

  • JIRA 1692 - Completion of Prov API functionalities for Client Library. (#9)

  • completed explore endpoints as a concept, and now working on the model run endpoint.

  • Completed prov-api L2 methods and setup of L3 methods.

  • Completed documentation and working on building the Admin Client of Prov-API.

  • commiting current changes, currently working on admin endpoints.

  • Completion of Prov-API, completed all documentation and remaining admin and CSV related endpoints.

  • Fixed missing parameters in two of the admin methods. One of the admin endpoints needs to be tested.

  • Completed Prov API with testing and improved the L2 and L3 layer exchange of the csv to model run method.

  • Completed pull request comments and updated open api endpoints fetch script through GPT.

  • Updated file writing functions according to pull request comments and created more flexibility between L2 and L3 for launching model runs endpoint.

  • Made writing file logic more robust by having more checks and throwing exceptions accordingly. Updated L2 method to encode string to bytes internally. (ccdcdaa)

  • Revert “refactoring”

This reverts commit b4f13026a3a93ef22843fc52487c10cbaacb4812. (0c39cee)

  • Revert “added read offline token from file. Need to consolidate offline and refreh token mishaps”

This reverts commit 0eb280a96a2f2935751cfa1a3be02d35a79879ec. (999a812)

  • Revert “improved error handling and tidying”

This reverts commit b5a679ab36a23dd9e1cb2c655775fbe234068c76. (186ec49)

  • git pushMerge branch ‘main’ of github.com:provena/provena-python-client into main (e333078)

  • Implements Job API L2 and L3 + additional L3 helper methods (#10)

  • Basic L2/L3 complete

  • Building out L3 functions to await completion of job lifecycle + list all + for all methods. (0871e96)

  • improved error handling and tidying (b5a679a)

  • added read offline token from file. Need to consolidate offline and refreh token mishaps (0eb280a)

  • refactoring (b4f1302)

  • Completion of Datastore Functionality (Need Review on Pagination Implementation) (#8)

  • In progressing completing of the datastore api’s.

  • (In progress) Completing the datastore client library functionality.

  • Completion of core datastore functionalities, and need a review on pagination implementation.

  • Updated pull request comments, implemented new pagination methods and removed api_exceptions list as they all inherit from BaseException.

  • Completion - Improved variable naming, changed structure of listing dataset methods to be flat and not nested and removed default sort options as this is handled by the API. (b9e976d)

  • Registry concept (#7)

  • Proof of concept for registry implementation

  • Adding documentation and mvp for registry implementation - not complete (7da100e)

  • JIRA 1687 - Fleshing out base structure of Prov, Registry, Job and Handle ID API’s (#6)

  • Completed a base setup for the remaining API’s (registry,prov) in respect to L2 and L3 and included all endpoints.

  • Completion of missing API implementation and used a more robust approach suggested by Ross for Registry Endpoint collection.

  • Changed handle to ID and implemented auto-generated routes for registry.

  • Implementing L2 and L3 for ID service, renaming client file.


Co-authored-by: Peter Baker peter.baker122@csiro.au (831e80b)

  • Complete L2 & L3 for Auth API (#5)

  • Implementing remaining L2 methods for auth api client

  • Direct map L3 methods

  • Adding placeholder L3 module for streamlining user links and adding doc strings for L2 auth API.

  • Transferring doc strings from L2 to L3 to match - auto docs need to pick these up

  • Minor corrections (26afd0a)

v0.2.0 (2024-05-30)

Features

  • feat: Updated the project version to not clash with pypi. (e67d002)

Unknown

  • Merge branch ‘main’ of github.com:provena/provena-python-client into main (293cf17)

v0.1.0 (2024-05-30)

Features

  • feat: Updated project version to not clash with pypi. (a02a0b1)

  • feat: implement datastore, search and auth client. (f33d689)

Unknown

  • Last attempt to make sphinx-auto-api work with CI job. (20b0819)

  • Updating sphinx-autoapi dependency version due to CI failure. (d464c31)

  • JIRA 1669 & 1677 Major: Implementing datastore interface & functionality of fetch and create dataset. (#3)

  • Created directory structure.

  • Initial structure of everything so far. I have been working on fleshing out the Auth interface as suggested by Peter, and made some progress.

  • Completion of Device Flow for Auth Class, and also created a separate. API client that wraps around request library for better testing of auth interface in the future.

  • Config Inteface, still needs to be reviewed. Furthermore, a decision needs to be made on how the endpoints are exposed to the user.

Co-authored-by: Ross (Laz) Petridis Rosspet@users.noreply.github.com

  • Pushing latest changes so Ross can branch off my branch for his offline flow development.

  • requirements conflict resolution

  • Completed base auth interface + device flow, and provided more type safety to the auth device flow methods.

Completed config interface file with docstrings and updated CI-CD script to only run on main.

  • feat(datastore): datastore fetch dataset functionality.

Implemented datastore fetch using the designed layers. Remaning work to design the custom exceptions and require review from others.

  • (Still In Progress ): Implementing custom Exceptions for various edge cases when recieving a response.

  • Merging main into datastore-interface branch for easier development.

  • Deleted redundant files. Due to file name change on main there were duplicate files that were not removed during merge.

  • (In Progress): Worked on mint dataset and fetch dataset functionality with the client library.

Facing some mypy issues and code needs to be reviewed for further enhancements.

  • (FEAT): Completed datastore functionality with fetch and create dataset and also updated CI/CD scripts to push to pypi and made them separated.

  • Reverted back to old ci-cd script setup as it would have ran in parallel instead of sequentially.

  • Updated ci-cd script to only run on pull requests is merged with base branch.

  • Improved robustness of JSON parsing from response object and created a list of exceptions for better clarity.

  • Removed requirements.txt

  • Proposed changes and additional functionality (#4)

  • Adding some additional poetry help in readme

  • Implements streamlined helper functions which are stacked/modular.

Simplifies error parsing in L2.

Applies formatting changes and other minor changes.

  • Improving file layout, adding convenience exports on key init.py files, moving testing out of import runway etc

  • Adding search L1, L2, L3. Adding search datasets with item loading to the datastore L3 construct demonstrating cross module dependencies. (L2 of search being used in L3 of data store).

  • Implementing auth api admin, introducing concept of sub clients and sub modules at L2 and L3 levels

  • Making refactor consistently use helper functions and adding documentation to new components/API endpoints

  • Adding endpoint gen from open api spec and using for auth APi

  • Implementing additional L2 endpoints for auth API

  • Adding comment for script

  • Ignoring openapi.json

Co-authored-by: Peter Baker 87056634+PeterBaker0@users.noreply.github.com


Co-authored-by: Ross (Laz) Petridis Rosspet@users.noreply.github.com Co-authored-by: Ross ross.petridis@csiro.au Co-authored-by: Peter Baker 87056634+PeterBaker0@users.noreply.github.com (897569c)

  • JIRA-1665 & 1667 Major: Implement Auth Flow & Implement Config Interface #2 (#2)

Completed base auth interface + device flow, provided more type safety to the auth device flow methods, completed config interface file with docstrings, and updated CI-CD script to only run on main.

co-authored-by: Ross ross.petridis@csiro.au (cb5b19b)

v0.0.0 (2024-04-05)

Unknown

  • Updated semantic release build command due to some issues with containers. Not sure if its the right fix. (https://github.com/python-semantic-release/python-semantic-release/issues/723) (6fec972)

  • JIRA-1630 Minor: Initial Stub Development for Provena Client Tool. (#1)

  • Created initial package setup with cookie-cutter template

  • Updated CI/CD script to only run on main branch, fixed incorrect imports and deleted files that were not needed

  • Integrated mypi in the package and was able to successfully build.

  • Shifted from a class to a data-class for Settings, updated CI-CD script and README.md and removed CONDUCT.md files.

  • Updated CI-CD script to use OCID instead of API tokens, and made it trigger on initial branch for testing purposes.

  • Simplifying CI-CD file to ensure it runs without issues.

  • Removed pull-request for now from CI/CD script.

  • Updated dependencies for CI

  • Updated poetry lock file for CI.

  • Added dummy test for CI to pass.

  • Updated CI to support pull request, as I am gonna merge pull request to main to release package.


Co-authored-by: Parth-Kulkarni (cfab8c2)

  • Update pull_request_template.md by removing RRAP references (3bd04b3)

  • Create pull_request_template.md (8666266)

  • Initial commit (5cc5d2d)