PLAT-473: Update export reports

.gitignore

@@ -4,3 +4,4 @@ notebooks/.ipynb_checkpoints
 .venv/
 .python-version
 __pycache__/
+.DS_Store

notebooks/Applications API.ipynb

@@ -59,8 +59,8 @@
    "source": [
     "application_route = \"/applications\"\n",
     "\n",
-    "# Source must be \"internal\" or \"vendor\"\n",
-    "# Type must be \"other\", \"genai\", \"classifier\", \"recommender\", \"regression\", or \"unsupervised\"\n",
+    "# Please see https://api.fairnow.dev/v2/docs for enumerated values for ApplicationSource and ApplicationType\n",
+    "\n",
     "request_body = {\n",
     "    \"name\": \"Your Application Name\",\n",
     "    \"source\": \"internal\",\n",

notebooks/Export Reports.ipynb

@@ -38,14 +38,13 @@
    "outputs": [],
    "source": [
     "# Add imports\n",
-    "from utils.dataframe_helpers import create_compliance_df\n",
+    "from utils.dataframe_helpers import create_application_compliance_df\n",
     "from utils.fairnow import export_to_tsv\n",
     "\n",
-    "# Create Compliance DataFrames for Application\n",
-    "# Note: DataFrames can be used for graphing or further analysis\n",
-    "application_compliance_df = create_compliance_df(client_id='client_id', control_type=\"application\") # Replace with your Client Id\n",
+    "# # Create Compliance DataFrames for Application\n",
+    "# # Note: DataFrames can be used for graphing or further analysis\n",
+    "application_compliance_df = create_application_compliance_df(client_id='client_id') # Replace with your Client Id\n",
     "\n",
-    "# Export to TSV\n",
     "export_to_tsv(application_compliance_df, 'application_compliance_export.tsv')"
    ]
   },
@@ -60,17 +59,15 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "6d64b2ac",
+   "id": "1a09ad93",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Add imports\n",
-    "from utils.dataframe_helpers import create_compliance_df\n",
+    "# # Add imports\n",
+    "from utils.dataframe_helpers import create_company_compliance_df\n",
     "from utils.fairnow import export_to_tsv\n",
     "\n",
-    "# Create Compliance DataFrames for Company\n",
-    "# Note: DataFrames can be used for graphing or further analysis\n",
-    "company_compliance_df = create_compliance_df(client_id='client_id', control_type=\"company\") # Replace with your Client Id\n",
+    "company_compliance_df = create_company_compliance_df(client_id='client_id') # Replace with your Client Id\n",
     "\n",
     "# Export to TSV\n",
     "export_to_tsv(company_compliance_df, 'company_compliance_export.tsv')"
@@ -147,7 +144,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.3"
+   "version": "3.13.7"
   }
  },
  "nbformat": 4,

notebooks/utils/api_helpers.py

@@ -1,15 +1,12 @@
-# utils/api_helpers.py
-import pandas as pd
-
-def get_application_data(client):
+def get_applications(client):
     """
-    Get application data from the FairNow API.
+    Get applications data from the FairNow API.
     """
-    application_route = "/applications"
+    route = "/applications"
 
     response = None
     try:
-        response = client.get(application_route, timeout=None)
+        response = client.get(route, timeout=None)
         if response.status_code == 200:
             response = response.json()
             return response
@@ -20,65 +17,34 @@ def get_application_data(client):
         print(e)
 
 
-def get_application_controls(client, application_id, application_version, control_type):
+def get_application_by_id(client, application_id: str):
     """
-    Get framework controls by framework ID from the FairNow API.
-    Returns a DataFrame directly with essential fields.
+    Get individual application data from the FairNow API.
     """
-    application_route = f"/controls/application/"
-    query_parameters = {
-                        "application_id": application_id,
-                        "application_version": application_version,
-                        "control_type": control_type # application or company
-                        }
+    route = f"/applications/{application_id}"
+
+    response = None
     try:
-        response = client.get(application_route, params=query_parameters, timeout=None)
+        response = client.get(route, timeout=None)
         if response.status_code == 200:
-            full_response = response.json()
-
-            # Create flattened data for DataFrame
-            flattened_data = []
-            for control in full_response.get('controls', []):
-                # For controls with frameworks, create a row for each framework
-                frameworks = control.get('frameworks_in_scope', [])
-                if frameworks:
-                    for framework in frameworks:
-                        flattened_data.append({
-                            'control_id': control.get('control_id'),
-                            'ready': control.get('ready'),
-                            'framework': framework,
-                            'application_id': application_id,
-                            'application_version': application_version
-                        })
-                else:
-                    # For controls without frameworks, create a single row
-                    flattened_data.append({
-                        'control_id': control.get('control_id'),
-                        'ready': control.get('ready'),
-                        'framework': '',
-                        'application_id': application_id,
-                        'application_version': application_version
-                    })
-
-            # Create DataFrame directly
-            return pd.DataFrame(flattened_data)
+            response = response.json()
+            return response
         else:
             print(f"Error: {response.status_code} - {response.text}")
             return None
     except Exception as e:
         print(e)
-        return None
 
 
 def get_frameworks(client):
     """
     Get framework data from the FairNow API.
     """
-    application_route = "/frameworks"
+    route = "/frameworks"
 
     response = None
     try:
-        response = client.get(application_route, timeout=None)
+        response = client.get(route, timeout=None)
         if response.status_code == 200:
             response = response.json()
             return response
@@ -89,36 +55,34 @@ def get_frameworks(client):
         print(e)
 
 
-def get_framework_controls(client, framework_id):
+def get_controls(client):
     """
-    Get framework controls by framework ID from the FairNow API.
+    Get controls data from the FairNow API.
     """
-    application_route = f"/controls/framework/"
-    query_parameters = {"framework_id": framework_id}
-    framework_response = None
-
+    route = "/controls"
+
+    response = None
     try:
-        response = client.get(application_route, params=query_parameters, timeout=None)
+        response = client.get(route, timeout=None)
         if response.status_code == 200:
-            framework_response = response.json()
-            return framework_response
+            response = response.json()
+            return response
         else:
             print(f"Error: {response.status_code} - {response.text}")
             return None
     except Exception as e:
         print(e)
-        return None
-
 
-def get_vendor_data(client):
+
+def get_vendors(client):
     """
     Get vendor data from the FairNow API.
     """
-    application_route = "/vendors/"
+    route = "/vendors"
 
     response = None
     try:
-        response = client.get(application_route, timeout=None)
+        response = client.get(route, timeout=None)
         if response.status_code == 200:
             response = response.json()
             return response