Docs 268 example script (#271)

* docs: adds example for removing source folders

* docs: updates example csv

Author: jtyoung84

docs/examples/example1.csv

@@ -1,4 +1,4 @@
 project_name, modality0.capsule_id, modality0, modality0.input_source, modality1, modality1.input_source, s3_bucket, subject_id, platform, acq_datetime, job_type
 Ephys Platform, , ecephys, dir/data_set_1, ,, default, 123454, ecephys, 2020-10-10 14:10:10, ecephys
-Behavior Platform, 1f999652-00a0-4c4b-99b5-64c2985ad070, behavior-videos, dir/data_set_2, MRI, dir/data_set_3, open, 123456, behavior, 10/13/2020 1:10:10 PM,
-Behavior Platform, , behavior-videos, dir/data_set_2, behavior, dir/data_set_3, private, 123456, behavior, 10/13/2020 1:10:10 PM,
+Behavior Platform, 1f999652-00a0-4c4b-99b5-64c2985ad070, behavior-videos, dir/data_set_2, MRI, dir/data_set_3, open, 123456, behavior, 10/13/2020 1:10:10 PM, default
+Behavior Platform, , behavior-videos, dir/data_set_2, behavior, dir/data_set_3, private, 123456, behavior, 10/13/2020 1:10:10 PM, default

docs/examples/remove_source_folders.py

@@ -0,0 +1,80 @@
+"""
+WARNING: This deletes raw data. Please use caution.
+This example demonstrates how to remove the source folders after the data
+has been uploaded to S3.
+"""
+
+from datetime import datetime
+
+import requests
+from aind_data_schema_models.modalities import Modality
+from aind_data_schema_models.platforms import Platform
+
+from aind_data_transfer_service.models.core import (
+    SubmitJobRequestV2,
+    Task,
+    UploadJobConfigsV2,
+)
+
+# The job_type contains the default settings for compression and Code Ocean
+# pipelines.
+job_type = "ecephys"
+
+acq_datetime = datetime(2023, 4, 3, 18, 17, 7)
+
+remove_source_folders = Task(skip_task=False)
+
+ecephys_task = Task(
+    job_settings={
+        "input_source": (
+            "/allen/aind/scratch/svc_aind_upload/test_data_sets/"
+            "ecephys/655019_2023-04-03_18-17-07"
+        )
+    }
+)
+
+modality_transformation_settings = {"ecephys": ecephys_task}
+
+gather_preliminary_metadata = Task(
+    job_settings={
+        "metadata_dir": (
+            "/allen/aind/scratch/svc_aind_upload/test_data_sets/"
+            "ecephys/655019_2023-04-03_18-17-07"
+        )
+    }
+)
+
+
+upload_job_configs_v2 = UploadJobConfigsV2(
+    job_type=job_type,
+    project_name="Ephys Platform",
+    platform=Platform.ECEPHYS,
+    modalities=[Modality.ECEPHYS],
+    subject_id="655019",
+    acq_datetime=acq_datetime,
+    tasks={
+        "modality_transformation_settings": modality_transformation_settings,
+        "gather_preliminary_metadata": gather_preliminary_metadata,
+        "remove_source_folders": remove_source_folders
+    },
+)
+
+submit_request_v2 = SubmitJobRequestV2(
+    upload_jobs=[upload_job_configs_v2],
+)
+
+post_request_content = submit_request_v2.model_dump(
+    mode="json", exclude_none=True
+)
+
+# Please use the production endpoint for submitting jobs and the dev endpoint
+# for running tests.
+# endpoint = "http://aind-data-transfer-service"
+endpoint = "http://aind-data-transfer-service-dev"  # For testing
+
+submit_job_response = requests.post(
+    url=f"{endpoint}/api/v2/submit_jobs",
+    json=post_request_content,
+)
+print(submit_job_response.status_code)
+print(submit_job_response.json())