Updated readme, restructuring of files, renaming of functions

README.md

@@ -71,16 +71,17 @@ with s3_fs.open('gaia/data') as file:
 
 # 2. Commit For File Processing
 
+Submit a file's content and file name to the ingestion API for further processing.
 The function will return a successfull response as soon as the file content is successfully stored and queued for further processing. Otherwise, the function will handle errors appropriately.
 A successfull response contains a task_id referring to the queued processing task. This can be used in [4. Query a L2 Processing Tasks State](#4-query-a-l2-processing-tasks-state) for querying a processing task's current state.
 
 ## Configuration
 The helper will send HTTP requests to an external API. CSST_BACKEND_API_URL env variable should be set accordingly.
 
-## Function: `submit_file_for_ingestion`
+## Function: `start_ingestion_task`
 
 ```python
-def submit_file_for_ingestion(file_content: str, file_name: str) -> dict:
+def start_ingestion_task(file_content: str, file_name: str) -> dict:
     """
     Submit a file's content and file name to the ingestion API.
 
@@ -105,9 +106,9 @@ Query for file info by metadata values.
 ## Configuration
 The helper will send HTTP requests to an external API. CSST_BACKEND_API_URL env variable should be set accordingly.
 
-## Function: `search_with_basic_filters`
+## Function: `query_metadata`
 ```python
-def search_with_basic_filters(
+def query_metadata(
     filter: Dict[str, Any],
     key: List[str],
 ) -> List[Dict[str, Any]]:
@@ -119,18 +120,26 @@ def search_with_basic_filters(
         key: A list of string values, corresponding to metadata keys that should be included in the output.
     Returns:
         A List[Dict] of matching documents containing a file_path value and the keys set as 'key' parameter under 'metadata'.
-        E.g. with key = ["dataset", "instrument", "obs_group", "obs_id"]
+        E.g. with key = ["CABEND", "qc_status"]
             then returns:
             [
                 {
-                    "file_path": "CSST_L0/MSC/SCI/60310/10100000000/MS/CSST_MSC_MS_SCIE_20290225043953_20290225044223_10100000000_03_L0_V01.fits",
+                    "urn": "s3://csst/testing/L1/MSC/msc-v093-r1/kKwmIwzv/SCI/10109300100413/CSST_MSC_MS_SCI_20231022050242_20231022050512_10109300100413_14_L1_V01.fits",
                     "metadata": {
-                        "dataset":"csst-msc-c11-1000sqdeg-wide-test-v2",
-                        "instrument":"MSC",
-                        "obs_group":"W1",
-                        "obs_id":"10200000000"
+                        "CABEND": "59785.82529",
+                        "qc_status": "0.0"
                     },
-                },
+                    "removed": false,
+                    "created": 1756284502817,
+                    "parentPath": "s3://csst/testing/L1/MSC/msc-v093-r1/kKwmIwzv/SCI/10109300100413/",
+                    "name": "CSST_MSC_MS_SCI_20231022050242_20231022050512_10109300100413_14_L1_V01.fits",
+                    "lastModified": 1756284502817,
+                    "grandParentPath": "s3://csst/testing/L1/MSC/msc-v093-r1/kKwmIwzv/SCI/",
+                    "platform": "s3",
+                    "tags": [
+                        "L1"
+                    ]
+                }
             ]
     """
 ```
@@ -176,9 +185,9 @@ Query the processing state of a processing task given a L2 task id.
 ## Configuration
 The helper will send HTTP requests to an external API. CSST_BACKEND_API_URL env variable should be set accordingly.
 
-## Function: `query_processing_task_state`
+## Function: `query_task_state`
 ```python
-def query_processing_task_state(
+def query_task_state(
     task_id: str
 ) -> Dict[str, Any]
     """
@@ -202,7 +211,7 @@ Query a star catalog by column values given a ra, dec and radius preselection.
 ## Configuration
 The helper will send HTTP requests to an external API. CSST_BACKEND_API_URL env variable should be set accordingly.
 
-## Function: `search_with_basic_filters`
+## Function: `query_star_catalog`
 ```python
 def query_star_catalog(
     catalog_name: str,

csst_fs/__init__.py

@@ -4,6 +4,6 @@ from .fits import fsspec_HDUList
 from .table import fsspec_table
 from . import s3_fs
 from . import fs
-from .commit import level2
-from .star_catalog import search
-from .metadata import search
+from .catalog.metadata import query_metadata
+from .catalog.star import query_star_catalog
+from .ingestion.level2 import start_ingestion_task, query_task_state
\ No newline at end of file

csst_fs/commit/level2.py → csst_fs/ingestion/level2.py

@@ -5,7 +5,7 @@ import time
 from typing import Dict, Any
 from csst_fs import s3_fs
 
-def submit_file_for_ingestion(file_content: bytes, file_name: str) -> Dict[str, str]:
+def start_ingestion_task(file_content: bytes, file_name: str) -> Dict[str, str]:
     """
     Submit a file for ingestion by:
     1. Requesting an OSS upload path from the ingestion API.
@@ -82,7 +82,7 @@ def submit_file_for_ingestion(file_content: bytes, file_name: str) -> Dict[str,
         raise RuntimeError(f"Unexpected response while reporting upload: {report_data}")
 
 
-def query_processing_task_state(task_id: str) -> Dict[str, Any]:
+def query_task_state(task_id: str) -> Dict[str, Any]:
     """
     Query the processing state of a processing task given a L2 task id.