From 74ba12d147d8409d130eaa783f8ec539bfac6af7 Mon Sep 17 00:00:00 2001 From: Andy Shapiro Date: Thu, 6 Feb 2025 18:56:27 -0500 Subject: [PATCH] add unpublished argument to bmd endpoints client --- client/hawc_client/animal.py | 5 +++-- docs/docs/client.md | 4 ++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/client/hawc_client/animal.py b/client/hawc_client/animal.py index c7934f007f..4c9d077a05 100644 --- a/client/hawc_client/animal.py +++ b/client/hawc_client/animal.py @@ -146,9 +146,10 @@ def endpoints(self, assessment_id: int, invert: bool = False) -> list[dict]: data = self._invert_endpoints(data) return data - def bmds_endpoints(self, assessment_id: int) -> pd.DataFrame: + def bmds_endpoints(self, assessment_id: int, unpublished: bool = False) -> pd.DataFrame: url = f"{self.session.root_url}/ani/api/assessment/{assessment_id}/bmds-export/" - response_json = self.session.get(url).json() + params = {"unpublished": unpublished} + response_json = self.session.get(url, params=params).json() return pd.DataFrame(response_json) def metadata(self) -> dict: diff --git a/docs/docs/client.md b/docs/docs/client.md index d5411d0059..9ad836c975 100644 --- a/docs/docs/client.md +++ b/docs/docs/client.md @@ -58,6 +58,10 @@ Client tutorials for common operations are below: ### Changelog +#### [2025-1](https://pypi.org/project/hawc-client/2025.1/) (TBD) + +* Add `unpublished` parameter to bmd dataset download + #### [2024-4](https://pypi.org/project/hawc-client/2024.4/) (January 2025) * Added assessment team member API endpoint to retrieve assessments a user is a member of