willisapi-client 2.0__tar.gz → 2.0.1__tar.gz

willisapi_client-2.0.1/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: willisapi_client
+Version: 2.0.1
+Summary: A Python client for willisapi
+Home-page: https://github.com/bklynhlth/willsiapi_client
+Author: bklynhlth
+Author-email: admin@brooklyn.health
+License: Apache
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.9.0
+Requires-Dist: aiosignal==1.3.1
+Requires-Dist: async-timeout==4.0.2
+Requires-Dist: asyncio==3.4.3
+Requires-Dist: attrs==23.1.0
+Requires-Dist: certifi==2023.7.22
+Requires-Dist: charset-normalizer==3.2.0
+Requires-Dist: frozenlist==1.4.0
+Requires-Dist: idna==3.4
+Requires-Dist: multidict==6.0.4
+Requires-Dist: nest-asyncio==1.5.7
+Requires-Dist: numpy==1.25.2
+Requires-Dist: pandas==2.0.3
+Requires-Dist: pytest==7.4.0
+Requires-Dist: pytest-cov==4.1.0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pytz==2023.3
+Requires-Dist: requests==2.31.0
+Requires-Dist: six==1.16.0
+Requires-Dist: tqdm==4.66.1
+Requires-Dist: tzdata==2023.3
+Requires-Dist: urllib3==2.0.7
+Requires-Dist: yarl==1.9.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+WillisAPI Client is the official Python client for interfacing with WillisAPI.
+
+WillisAPI allows for sharing data between third-party systems and the Willis platform, developed and maintained by Brooklyn Health. 
+
+To learn more about Willis or Brooklyn Health, please visit [brooklyn.health](https://brooklyn.health).
+
+## Installation
+
+Before you begin, we recommend creating a virtual environment for the client and using a Python version later than 3.10.
+
+```shell
+pip install virtualenv
+virtualenv willisapi_client --python=3.10
+source willisapi_client/bin/activate
+```
+
+To install WillisAPI client, run:
+
+```shell
+pip install willisapi_client
+```
+
+After installation is complete, enter a python environment. Then, import the library:
+
+```py
+import willisapi_client as willisapi
+```
+
+## Access
+
+To use any of the client’s functions, the user will need a personal access token (PAT).
+
+This key will be provided to authorized users by Brooklyn Health staff. To get your key, please reach out to your technical contact at Brooklyn Health.
+
+## Documentation
+
+For complete documentation on use, please visit the [WillisAPI Client Wiki](https://github.com/bklynhlth/willisapi_client/wiki).

willisapi_client-2.0.1/README.md

@@ -0,0 +1,37 @@
+WillisAPI Client is the official Python client for interfacing with WillisAPI.
+
+WillisAPI allows for sharing data between third-party systems and the Willis platform, developed and maintained by Brooklyn Health. 
+
+To learn more about Willis or Brooklyn Health, please visit [brooklyn.health](https://brooklyn.health).
+
+## Installation
+
+Before you begin, we recommend creating a virtual environment for the client and using a Python version later than 3.10.
+
+```shell
+pip install virtualenv
+virtualenv willisapi_client --python=3.10
+source willisapi_client/bin/activate
+```
+
+To install WillisAPI client, run:
+
+```shell
+pip install willisapi_client
+```
+
+After installation is complete, enter a python environment. Then, import the library:
+
+```py
+import willisapi_client as willisapi
+```
+
+## Access
+
+To use any of the client’s functions, the user will need a personal access token (PAT).
+
+This key will be provided to authorized users by Brooklyn Health staff. To get your key, please reach out to your technical contact at Brooklyn Health.
+
+## Documentation
+
+For complete documentation on use, please visit the [WillisAPI Client Wiki](https://github.com/bklynhlth/willisapi_client/wiki).

{willisapi_client-2.0 → willisapi_client-2.0.1}/willisapi_client/__version__.py

@@ -1,7 +1,7 @@
 """Version details for willisapi_client"""
 
 __client__ = "willisapi_client"
-__latestVersion__ = "2.0"
+__latestVersion__ = "2.0.1"
 __url__ = "https://github.com/bklynhlth/willsiapi_client"
 __short_description__ = "A Python client for willisapi"
 __content_type__ = "text/markdown"

{willisapi_client-2.0 → willisapi_client-2.0.1}/willisapi_client/services/metadata/upload.py

@@ -75,6 +75,21 @@ def _put_file_to_s3(file_presigned: dict):
     return None
 
 
+def _last_postable_position(df, validate) -> int:
+    """Position of the final row that will actually be Posted to the API.
+
+    Rows failing client-side validation are never sent, so the is_last_row
+    flag (which triggers the server-side upload-summary notification) must
+    ride on the last row that survives it. Returns -1 when no row will post.
+    """
+    last_pos = -1
+    for pos, (_, row) in enumerate(df.iterrows()):
+        valid, _ = validate(UploadUtils(row))
+        if valid:
+            last_pos = pos
+    return last_pos
+
+
 @measure
 def upload(api_key: str, csv_path: str, **kwargs):
 
@@ -98,16 +113,22 @@ def upload(api_key: str, csv_path: str, **kwargs):
             upload_type="data",
             env=kwargs.get("env"),
         )
+        last_post_pos = _last_postable_position(
+            csv.transformed_df, lambda u: u.validate_row()
+        )
 
         results = []
-        for index, row in tqdm(
-            csv.transformed_df.iterrows(), total=csv.transformed_df.shape[0]
+        for pos, (index, row) in enumerate(
+            tqdm(csv.transformed_df.iterrows(), total=csv.transformed_df.shape[0])
         ):
             u = UploadUtils(row)
             valid, err = u.validate_row()
             result_row = row.to_dict()
             if valid:
-                payload = u.generate_payload()
+                payload = u.generate_payload(
+                    record_id=archive_record_id,
+                    is_last_row=(pos == last_post_pos),
+                )
                 res = u.post(api_key, url, headers, payload)
                 if res.get("upload_status") == "Success":
                     result_row["upload_status"] = "Success"
@@ -209,6 +230,9 @@ def processed_upload(api_key: str, csv_path: str, output_path: str, **kwargs):
             upload_type="processed_data",
             env=kwargs.get("env"),
         )
+        last_post_pos = _last_postable_position(
+            csv.transformed_df, lambda u: u.validate_processed_data_row()
+        )
 
         results = []
         # Throttle S3 uploads: pause 3s each time the running total of files
@@ -217,8 +241,8 @@ def processed_upload(api_key: str, csv_path: str, output_path: str, **kwargs):
         S3_SLEEP_SECONDS = 3
         s3_uploaded_total = 0
         next_sleep_threshold = S3_SLEEP_EVERY
-        for index, row in tqdm(
-            csv.transformed_df.iterrows(), total=csv.transformed_df.shape[0]
+        for pos, (index, row) in enumerate(
+            tqdm(csv.transformed_df.iterrows(), total=csv.transformed_df.shape[0])
         ):
             u = UploadUtils(row)
             valid, err = u.validate_processed_data_row()
@@ -249,7 +273,12 @@ def processed_upload(api_key: str, csv_path: str, output_path: str, **kwargs):
                                 "checksum": checksum,
                             }
                         )
-                payload = u.generate_processed_payload(files, score_type=score_type)
+                payload = u.generate_processed_payload(
+                    files,
+                    score_type=score_type,
+                    record_id=archive_record_id,
+                    is_last_row=(pos == last_post_pos),
+                )
                 res = u.post(api_key, url, headers, payload)
                 if res.get("upload_status") == "Success":
                     result_row["upload_status"] = "Success"
@@ -265,9 +294,7 @@ def processed_upload(api_key: str, csv_path: str, output_path: str, **kwargs):
                     if files_to_upload:
                         max_workers = min(len(files_to_upload), os.cpu_count() or 1)
                         with ThreadPoolExecutor(max_workers=max_workers) as executor:
-                            for error in executor.map(
-                                _put_file_to_s3, files_to_upload
-                            ):
+                            for error in executor.map(_put_file_to_s3, files_to_upload):
                                 if error:
                                     s3_errors.append(error)
                         # Pause after every 100 files uploaded to S3.

{willisapi_client-2.0 → willisapi_client-2.0.1}/willisapi_client/services/metadata/utils.py

@@ -18,6 +18,7 @@ from dateutil import parser
 
 ALLOWED_COA_NAMES = ["MADRS", "YMRS", "PHQ-9", "GAD-7", "HAM-D17", "HAMD17"]
 
+
 @lru_cache(maxsize=None)
 def build_retry_session(total: int = 3, backoff_factor: float = 1) -> requests.Session:
     """Return a requests Session that retries transient network failures.
@@ -44,6 +45,7 @@ def build_retry_session(total: int = 3, backoff_factor: float = 1) -> requests.S
     session.mount("http://", adapter)
     return session
 
+
 COA_ITEM_COUNTS = {
     "MADRS": 10,
     "YMRS": 10,
@@ -509,7 +511,9 @@ class UploadUtils:
 
         return supplied
 
-    def generate_payload(self) -> Dict[str, Any]:
+    def generate_payload(
+        self, record_id: str = None, is_last_row: bool = False
+    ) -> Dict[str, Any]:
         payload = {
             "study_id": self.row.study_id,
             "site_id": self.row.site_id,
@@ -528,10 +532,20 @@ class UploadUtils:
             # "time_collected": parser.parse(self.row.time_collected).isoformat(),
         }
         payload.update(self.demographic_fields())
+        # Tie this row to its CSV tracking record so the server can accumulate
+        # notification metrics; is_last_row on the final posted row triggers
+        # the server-side upload-summary notification.
+        if record_id:
+            payload["record_id"] = record_id
+            payload["is_last_row"] = bool(is_last_row)
         return payload
 
     def generate_processed_payload(
-        self, files: List[Dict[str, str]], score_type: str = "rater"
+        self,
+        files: List[Dict[str, str]],
+        score_type: str = "rater",
+        record_id: str = None,
+        is_last_row: bool = False,
     ) -> Dict[str, Any]:
         recording_val = getattr(self.row, "recording", None)
         payload = {
@@ -554,6 +568,12 @@ class UploadUtils:
         if site_country:
             payload["site_country"] = site_country
         payload.update(self.demographic_fields())
+        # Tie this row to its CSV tracking record so the server can accumulate
+        # notification metrics; is_last_row on the final posted row triggers
+        # the server-side upload-summary notification.
+        if record_id:
+            payload["record_id"] = record_id
+            payload["is_last_row"] = bool(is_last_row)
         return payload
 
     def post(

willisapi_client-2.0.1/willisapi_client.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: willisapi_client
+Version: 2.0.1
+Summary: A Python client for willisapi
+Home-page: https://github.com/bklynhlth/willsiapi_client
+Author: bklynhlth
+Author-email: admin@brooklyn.health
+License: Apache
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.9.0
+Requires-Dist: aiosignal==1.3.1
+Requires-Dist: async-timeout==4.0.2
+Requires-Dist: asyncio==3.4.3
+Requires-Dist: attrs==23.1.0
+Requires-Dist: certifi==2023.7.22
+Requires-Dist: charset-normalizer==3.2.0
+Requires-Dist: frozenlist==1.4.0
+Requires-Dist: idna==3.4
+Requires-Dist: multidict==6.0.4
+Requires-Dist: nest-asyncio==1.5.7
+Requires-Dist: numpy==1.25.2
+Requires-Dist: pandas==2.0.3
+Requires-Dist: pytest==7.4.0
+Requires-Dist: pytest-cov==4.1.0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pytz==2023.3
+Requires-Dist: requests==2.31.0
+Requires-Dist: six==1.16.0
+Requires-Dist: tqdm==4.66.1
+Requires-Dist: tzdata==2023.3
+Requires-Dist: urllib3==2.0.7
+Requires-Dist: yarl==1.9.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+WillisAPI Client is the official Python client for interfacing with WillisAPI.
+
+WillisAPI allows for sharing data between third-party systems and the Willis platform, developed and maintained by Brooklyn Health. 
+
+To learn more about Willis or Brooklyn Health, please visit [brooklyn.health](https://brooklyn.health).
+
+## Installation
+
+Before you begin, we recommend creating a virtual environment for the client and using a Python version later than 3.10.
+
+```shell
+pip install virtualenv
+virtualenv willisapi_client --python=3.10
+source willisapi_client/bin/activate
+```
+
+To install WillisAPI client, run:
+
+```shell
+pip install willisapi_client
+```
+
+After installation is complete, enter a python environment. Then, import the library:
+
+```py
+import willisapi_client as willisapi
+```
+
+## Access
+
+To use any of the client’s functions, the user will need a personal access token (PAT).
+
+This key will be provided to authorized users by Brooklyn Health staff. To get your key, please reach out to your technical contact at Brooklyn Health.
+
+## Documentation
+
+For complete documentation on use, please visit the [WillisAPI Client Wiki](https://github.com/bklynhlth/willisapi_client/wiki).

willisapi_client-2.0/PKG-INFO

@@ -1,165 +0,0 @@
-Metadata-Version: 2.4
-Name: willisapi_client
-Version: 2.0
-Summary: A Python client for willisapi
-Home-page: https://github.com/bklynhlth/willsiapi_client
-Author: bklynhlth
-Author-email: admin@brooklyn.health
-License: Apache
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aiohttp==3.9.0
-Requires-Dist: aiosignal==1.3.1
-Requires-Dist: async-timeout==4.0.2
-Requires-Dist: asyncio==3.4.3
-Requires-Dist: attrs==23.1.0
-Requires-Dist: certifi==2023.7.22
-Requires-Dist: charset-normalizer==3.2.0
-Requires-Dist: frozenlist==1.4.0
-Requires-Dist: idna==3.4
-Requires-Dist: multidict==6.0.4
-Requires-Dist: nest-asyncio==1.5.7
-Requires-Dist: numpy==1.25.2
-Requires-Dist: pandas==2.0.3
-Requires-Dist: pytest==7.4.0
-Requires-Dist: pytest-cov==4.1.0
-Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: pytz==2023.3
-Requires-Dist: requests==2.31.0
-Requires-Dist: six==1.16.0
-Requires-Dist: tqdm==4.66.1
-Requires-Dist: tzdata==2023.3
-Requires-Dist: urllib3==2.0.7
-Requires-Dist: yarl==1.9.2
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-<!-- Output copied to clipboard! -->
-
-<!-----
-
-Yay, no errors, warnings, or alerts!
-
-Conversion time: 0.36 seconds.
-
-
-Using this Markdown file:
-
-1. Paste this output into your source file.
-2. See the notes and action items below regarding this conversion run.
-3. Check the rendered output (headings, lists, code blocks, tables) for proper
-   formatting and use a linkchecker before you publish this page.
-
-Conversion notes:
-
-* Docs to Markdown version 1.0β34
-* Mon Aug 21 2023 13:41:56 GMT-0700 (PDT)
-* Source doc: README.md
------>
-
-
-
-### WillisAPI Client
-
-WillisAPI Client is the Python interface for Brooklyn Health’s WillisAPI.
-
-Official documentation for WillisAPI Client can be found in the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-To learn more about Brooklyn Health or WillisAPI, visit [brooklyn.health](https://www.brooklyn.health) or [getintouch@brooklyn.health](mailto:getintouch@brooklyn.health).
-
----
-
-#### Installation
-
-
-```bash
-pip install willisapi_client
-```
-
----
-
-#### Getting a Personal Access Token (PAT)
-1. Log in to the Brooklyn Health web application.
-2. Go to your profile section.
-3. Navigate to Personal Access Token (PAT) and copy it for use in the client.
-
----
-
-#### Usage
-
-**Upload**
-To upload a CSV file:
-
-```python
-summary = willisapi.upload(key, '/path/to/data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- data.csv: Path to your CSV file.
-
-How to Reupload
-
-If you need to reupload the same or updated file, simply call the upload function again:
-
-```python
-summary = willisapi.upload(key, 'data.csv', force_uploade=True)
-```
----
-#### Understanding Returned DataFrame and Errors
-
-- The upload function returns a summary DataFrame containing the results of your upload.
-- Columns typically include status, error messages, and metadata for each row in your CSV.
-- If there are errors, they will be listed in the DataFrame under an error or message column.
-- Review the DataFrame to identify and resolve any issues before reuploading.
-
----
-
-#### CSV Validation Details
-
-Before uploading, the client validates your CSV for:
-
-- **Required Columns**: Must include study_id, site_id, participant_id, visit_name, visit_order, coa_name, coa_item_number, coa_item_value, file_path, time_collected.
-- **Optional Columns**: rater_id, age, sex, race, language.
-- **Valid COA Name**: Only these values are allowed: MADRS, YMRS, PHQ-9, GAD-7.
-- **Valid Audio File**: The file path in each row must exist and be accessible.
-- **Valid Data Types**: visit_order, age, coa_item_number, and coa_item_value must be numeric.
-- **Language**: If present, must be in the allowed language choices.
-
-If any validation fails, errors are collected and returned for review before upload proceeds.
-
----
-
-**Processed Data Upload**
-
-To upload a processed data CSV file:
-
-```python
-summary = willisapi.processed_upload(key, '/path/to/processed-data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- processed-data.csv: Path to your processed data CSV file.
-
----
-
-For more information on how to organize the `data.csv`, visit the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-
-If you run into trouble while using the client, please raise it in the [Issues](http://www.github.com/bklynhlth/willisapi_client/issues) tab. 
-
-***
-
-Brooklyn Health is a small team of clinicians, scientists, and engineers based in Brooklyn, NY. 
-
-We develop and maintain [OpenWillis](http://www.github.com/bklynhlth/openwillis), an open source python library for digital health measurement. 

willisapi_client-2.0/README.md

@@ -1,120 +0,0 @@
-<!-- Output copied to clipboard! -->
-
-<!-----
-
-Yay, no errors, warnings, or alerts!
-
-Conversion time: 0.36 seconds.
-
-
-Using this Markdown file:
-
-1. Paste this output into your source file.
-2. See the notes and action items below regarding this conversion run.
-3. Check the rendered output (headings, lists, code blocks, tables) for proper
-   formatting and use a linkchecker before you publish this page.
-
-Conversion notes:
-
-* Docs to Markdown version 1.0β34
-* Mon Aug 21 2023 13:41:56 GMT-0700 (PDT)
-* Source doc: README.md
------>
-
-
-
-### WillisAPI Client
-
-WillisAPI Client is the Python interface for Brooklyn Health’s WillisAPI.
-
-Official documentation for WillisAPI Client can be found in the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-To learn more about Brooklyn Health or WillisAPI, visit [brooklyn.health](https://www.brooklyn.health) or [getintouch@brooklyn.health](mailto:getintouch@brooklyn.health).
-
----
-
-#### Installation
-
-
-```bash
-pip install willisapi_client
-```
-
----
-
-#### Getting a Personal Access Token (PAT)
-1. Log in to the Brooklyn Health web application.
-2. Go to your profile section.
-3. Navigate to Personal Access Token (PAT) and copy it for use in the client.
-
----
-
-#### Usage
-
-**Upload**
-To upload a CSV file:
-
-```python
-summary = willisapi.upload(key, '/path/to/data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- data.csv: Path to your CSV file.
-
-How to Reupload
-
-If you need to reupload the same or updated file, simply call the upload function again:
-
-```python
-summary = willisapi.upload(key, 'data.csv', force_uploade=True)
-```
----
-#### Understanding Returned DataFrame and Errors
-
-- The upload function returns a summary DataFrame containing the results of your upload.
-- Columns typically include status, error messages, and metadata for each row in your CSV.
-- If there are errors, they will be listed in the DataFrame under an error or message column.
-- Review the DataFrame to identify and resolve any issues before reuploading.
-
----
-
-#### CSV Validation Details
-
-Before uploading, the client validates your CSV for:
-
-- **Required Columns**: Must include study_id, site_id, participant_id, visit_name, visit_order, coa_name, coa_item_number, coa_item_value, file_path, time_collected.
-- **Optional Columns**: rater_id, age, sex, race, language.
-- **Valid COA Name**: Only these values are allowed: MADRS, YMRS, PHQ-9, GAD-7.
-- **Valid Audio File**: The file path in each row must exist and be accessible.
-- **Valid Data Types**: visit_order, age, coa_item_number, and coa_item_value must be numeric.
-- **Language**: If present, must be in the allowed language choices.
-
-If any validation fails, errors are collected and returned for review before upload proceeds.
-
----
-
-**Processed Data Upload**
-
-To upload a processed data CSV file:
-
-```python
-summary = willisapi.processed_upload(key, '/path/to/processed-data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- processed-data.csv: Path to your processed data CSV file.
-
----
-
-For more information on how to organize the `data.csv`, visit the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-
-If you run into trouble while using the client, please raise it in the [Issues](http://www.github.com/bklynhlth/willisapi_client/issues) tab. 
-
-***
-
-Brooklyn Health is a small team of clinicians, scientists, and engineers based in Brooklyn, NY. 
-
-We develop and maintain [OpenWillis](http://www.github.com/bklynhlth/openwillis), an open source python library for digital health measurement. 

willisapi_client-2.0/willisapi_client.egg-info/PKG-INFO

@@ -1,165 +0,0 @@
-Metadata-Version: 2.4
-Name: willisapi_client
-Version: 2.0
-Summary: A Python client for willisapi
-Home-page: https://github.com/bklynhlth/willsiapi_client
-Author: bklynhlth
-Author-email: admin@brooklyn.health
-License: Apache
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aiohttp==3.9.0
-Requires-Dist: aiosignal==1.3.1
-Requires-Dist: async-timeout==4.0.2
-Requires-Dist: asyncio==3.4.3
-Requires-Dist: attrs==23.1.0
-Requires-Dist: certifi==2023.7.22
-Requires-Dist: charset-normalizer==3.2.0
-Requires-Dist: frozenlist==1.4.0
-Requires-Dist: idna==3.4
-Requires-Dist: multidict==6.0.4
-Requires-Dist: nest-asyncio==1.5.7
-Requires-Dist: numpy==1.25.2
-Requires-Dist: pandas==2.0.3
-Requires-Dist: pytest==7.4.0
-Requires-Dist: pytest-cov==4.1.0
-Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: pytz==2023.3
-Requires-Dist: requests==2.31.0
-Requires-Dist: six==1.16.0
-Requires-Dist: tqdm==4.66.1
-Requires-Dist: tzdata==2023.3
-Requires-Dist: urllib3==2.0.7
-Requires-Dist: yarl==1.9.2
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-<!-- Output copied to clipboard! -->
-
-<!-----
-
-Yay, no errors, warnings, or alerts!
-
-Conversion time: 0.36 seconds.
-
-
-Using this Markdown file:
-
-1. Paste this output into your source file.
-2. See the notes and action items below regarding this conversion run.
-3. Check the rendered output (headings, lists, code blocks, tables) for proper
-   formatting and use a linkchecker before you publish this page.
-
-Conversion notes:
-
-* Docs to Markdown version 1.0β34
-* Mon Aug 21 2023 13:41:56 GMT-0700 (PDT)
-* Source doc: README.md
------>
-
-
-
-### WillisAPI Client
-
-WillisAPI Client is the Python interface for Brooklyn Health’s WillisAPI.
-
-Official documentation for WillisAPI Client can be found in the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-To learn more about Brooklyn Health or WillisAPI, visit [brooklyn.health](https://www.brooklyn.health) or [getintouch@brooklyn.health](mailto:getintouch@brooklyn.health).
-
----
-
-#### Installation
-
-
-```bash
-pip install willisapi_client
-```
-
----
-
-#### Getting a Personal Access Token (PAT)
-1. Log in to the Brooklyn Health web application.
-2. Go to your profile section.
-3. Navigate to Personal Access Token (PAT) and copy it for use in the client.
-
----
-
-#### Usage
-
-**Upload**
-To upload a CSV file:
-
-```python
-summary = willisapi.upload(key, '/path/to/data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- data.csv: Path to your CSV file.
-
-How to Reupload
-
-If you need to reupload the same or updated file, simply call the upload function again:
-
-```python
-summary = willisapi.upload(key, 'data.csv', force_uploade=True)
-```
----
-#### Understanding Returned DataFrame and Errors
-
-- The upload function returns a summary DataFrame containing the results of your upload.
-- Columns typically include status, error messages, and metadata for each row in your CSV.
-- If there are errors, they will be listed in the DataFrame under an error or message column.
-- Review the DataFrame to identify and resolve any issues before reuploading.
-
----
-
-#### CSV Validation Details
-
-Before uploading, the client validates your CSV for:
-
-- **Required Columns**: Must include study_id, site_id, participant_id, visit_name, visit_order, coa_name, coa_item_number, coa_item_value, file_path, time_collected.
-- **Optional Columns**: rater_id, age, sex, race, language.
-- **Valid COA Name**: Only these values are allowed: MADRS, YMRS, PHQ-9, GAD-7.
-- **Valid Audio File**: The file path in each row must exist and be accessible.
-- **Valid Data Types**: visit_order, age, coa_item_number, and coa_item_value must be numeric.
-- **Language**: If present, must be in the allowed language choices.
-
-If any validation fails, errors are collected and returned for review before upload proceeds.
-
----
-
-**Processed Data Upload**
-
-To upload a processed data CSV file:
-
-```python
-summary = willisapi.processed_upload(key, '/path/to/processed-data.csv')
-```
-
-How to Call the Function
-- key: Your PAT token.
-- processed-data.csv: Path to your processed data CSV file.
-
----
-
-For more information on how to organize the `data.csv`, visit the [Github Wiki](http://www.github.com/bklynhlth/willisapi_client/wiki).
-
-
-If you run into trouble while using the client, please raise it in the [Issues](http://www.github.com/bklynhlth/willisapi_client/issues) tab. 
-
-***
-
-Brooklyn Health is a small team of clinicians, scientists, and engineers based in Brooklyn, NY. 
-
-We develop and maintain [OpenWillis](http://www.github.com/bklynhlth/openwillis), an open source python library for digital health measurement.