Ability to dump linkage sets.

Author: pudo

.gitignore

@@ -4,6 +4,7 @@
 .vscode/
 tsconfig.json
 jsconfig.json
+.DS_Store
 
 ### Python ###
 # Byte-compiled / optimized / DLL files

alephclient/api.py

@@ -108,18 +108,18 @@ def search(self, query, schema=None, schemata=None, filters=None):
             filters.append(('schemata', schemata))
         if schema is None and schemata is None:
             filters.append(('schemata', 'Thing'))
-        url = self._make_url("entities", query=query, filters=filters)
+        url = self._make_url('entities', query=query, filters=filters)
         return APIResultSet(self, url)
 
     def get_collection(self, collection_id):
         """Get a single collection by ID (not foreign ID!)."""
-        url = self._make_url("collections/{0}".format(collection_id))
-        return self._request("GET", url)
+        url = self._make_url('collections/{0}'.format(collection_id))
+        return self._request('GET', url)
 
     def get_entity(self, entity_id):
         """Get a single entity by ID."""
-        url = self._make_url("entities/{0}".format(entity_id))
-        return self._request("GET", url)
+        url = self._make_url('entities/{0}'.format(entity_id))
+        return self._request('GET', url)
 
     def get_collection_by_foreign_id(self, foreign_id):
         """Get a dict representing a collection based on its foreign ID."""
@@ -194,8 +194,7 @@ def map_collection(self, collection_id, mapping):
         url = self._make_url("collections/{0}/mapping".format(collection_id))
         return self._request("PUT", url, json=mapping)
 
-    def stream_entities(self, collection_id=None, include=None,
-                        schema=None, decode_json=True):
+    def stream_entities(self, collection_id=None, include=None, schema=None):
         """Iterate over all entities in the given collection.
 
         params
@@ -275,6 +274,12 @@ def match(self, entity, collection_ids=None, url=None):
         except RequestException as exc:
             raise AlephException(exc)
 
+    def linkages(self, context_ids=None):
+        """Stream all linkages within the given role contexts."""
+        filters = [('context_id', c) for c in ensure_list(context_ids)]
+        url = self._make_url('linkages', filters=filters)
+        return APIResultSet(self, url)
+
     def ingest_upload(self, collection_id, file_path=None, metadata=None):
         """
         Create an empty folder in a collection or upload a document to it

alephclient/cli.py

@@ -108,8 +108,24 @@ def stream_entities(ctx, outfile, schema, foreign_id):
         if collection is None:
             raise click.BadParameter("Collection %r not found!" % foreign_id)
         for entity in api.stream_entities(collection_id=collection.get('id'),
-                                          include=include, schema=schema,
-                                          decode_json=False):
+                                          include=include, schema=schema):
+            outfile.write(json.dumps(entity))
+            outfile.write('\n')
+    except AlephException as exc:
+        raise click.ClickException(exc.message)
+    except BrokenPipeError:
+        raise click.Abort()
+
+
+@cli.command('linkages')
+@click.option('-o', '--outfile', type=click.File('w'), default='-')  # noqa
+@click.option('-c', '--context', multiple=True, default=[])  # noqa
+@click.pass_context
+def linkages(ctx, outfile, context):
+    """Stream all linkages within the given role contexts."""
+    api = ctx.obj["api"]
+    try:
+        for entity in api.linkages(context_ids=context):
             outfile.write(json.dumps(entity))
             outfile.write('\n')
     except AlephException as exc: