better search results in terminal

Author: emptymalei

dataherb/cmd/configs.py

@@ -48,6 +48,3 @@ def load_dataherb_config(config_path=None, no_config_error=True):
         conf = {}
 
     return conf
-
-
-

dataherb/cmd/search.py

@@ -0,0 +1,48 @@
+from rich.table import Table
+from rich.tree import Tree
+from rich.panel import Panel
+
+
+class HerbTable:
+    """Format search result
+
+    A flora search result has the following structure:
+    ```
+    """
+
+    def __init__(self, herb):
+        self.herb = herb
+
+    def panel(self):
+
+        self.table()
+        self.resource_tree()
+
+    def table(self):
+        """Summary Table"""
+        table = Table(title=f"DataHerb: {self.herb.name}", show_lines=True)
+
+        table.add_column("key", justify="right", style="cyan", no_wrap=False)
+        table.add_column("value", style="magenta", no_wrap=False)
+
+        table.add_row(f"ID", f"{self.herb.id}")
+        table.add_row(f"Name", f"{self.herb.name}")
+        table.add_row(f"Source", f"{self.herb.source}")
+        table.add_row(f"Description", f"{self.herb.description}")
+        table.add_row(f"URI", f"{self.herb.uri}")
+        table.add_row(f"Metadata", f"{self.herb.metadata_uri}")
+
+        pl = Panel(table, title=f"Summary of {self.herb.id}")
+
+        return pl
+
+    def resource_tree(self):
+        """Show list of resources"""
+
+        tree = Tree(f"{self.herb.id}")
+        for r in self.herb.resources:
+            tree.add(f'{r.descriptor.get("path")}')
+
+        pl = Panel(tree, title=f"Resources of {self.herb.id}")
+
+        return pl

dataherb/cmd/sync_git.py

@@ -38,13 +38,9 @@ def upload_dataset_to_git(source, target, experimental=False):
             f"Please go to {source} and sync your git repository to {target} manually.\n"
         )
         if is_git_initialized:
-            text += (
-                f"Note: simply add, commit and push."
-            )
+            text += f"Note: simply add, commit and push."
         else:
-            text += (
-                f"Note: git init your repo, commit, add remote {target}, and push."
-            )
+            text += f"Note: git init your repo, commit, add remote {target}, and push."
         click.echo(text)
     else:
         if is_git_initialized:
@@ -53,20 +49,23 @@ def upload_dataset_to_git(source, target, experimental=False):
             repo.index.commit("created datset: added dataherb.json")
 
             if len(repo.remotes) == 0:
-                origin = repo.create_remote('origin', target)
+                origin = repo.create_remote("origin", target)
                 assert origin.exists()
                 origin.fetch()
-                repo.create_head('master', origin.refs.master).set_tracking_branch(origin.refs.master).checkout()
+                repo.create_head("master", origin.refs.master).set_tracking_branch(
+                    origin.refs.master
+                ).checkout()
                 origin.push()
             else:
                 repo.git.push()
         else:
             repo = git.Repo.init(source)
             repo.git.add(["*"])
             repo.index.commit("initial commit")
-            origin = repo.create_remote('origin', target)
+            origin = repo.create_remote("origin", target)
             assert origin.exists()
             origin.fetch()
-            repo.create_head('master', origin.refs.master).set_tracking_branch(origin.refs.master).checkout()
+            repo.create_head("master", origin.refs.master).set_tracking_branch(
+                origin.refs.master
+            ).checkout()
             origin.push()
-

dataherb/command.py

@@ -1,16 +1,18 @@
 import json
-import os, sys
+import os
+import sys
 from pathlib import Path
 
 import click
-from rich.console import Console
 import git
-from datapackage import Package
 import inquirer
+from datapackage import Package
 from loguru import logger
 from mkdocs.commands.serve import serve as _serve
+from rich.console import Console
 
 from dataherb.cmd.create import describe_dataset
+from dataherb.cmd.search import HerbTable
 from dataherb.cmd.sync_git import upload_dataset_to_git
 from dataherb.cmd.sync_s3 import upload_dataset_to_s3
 from dataherb.core.base import Herb
@@ -39,8 +41,15 @@ def dataherb(ctx):
 
 
 @dataherb.command()
-@click.option('--show/--no-show', '-s/ ', default=False, help="Show the current configuration")
-@click.option('--locate/--no-locate', '-l/ ', default=False, help="Locate the folder that contains the configuration")
+@click.option(
+    "--show/--no-show", "-s/ ", default=False, help="Show the current configuration"
+)
+@click.option(
+    "--locate/--no-locate",
+    "-l/ ",
+    default=False,
+    help="Locate the folder that contains the configuration",
+)
 def configure(show, locate):
     """
     Configure dataherb; inspect, or lcoate the current configurations.
@@ -95,36 +104,42 @@ def configure(show, locate):
         with open(config_path, "w") as f:
             json.dump(config, f, indent=4)
 
-        click.secho(
-            f"The dataherb config has been saved to {config_path}!", fg="green"
-        )
+        click.secho(f"The dataherb config has been saved to {config_path}!", fg="green")
     else:
         if not config_path.exists():
             click.secho(f"Config file ({config_path}) doesn't exist.", fg="red")
         else:
             c = Config()
             click.secho(f"The current config for dataherb is:")
-            click.secho(json.dumps(c.config, indent=2, sort_keys=True, ensure_ascii=False))
+            click.secho(
+                json.dumps(c.config, indent=2, sort_keys=True, ensure_ascii=False)
+            )
             click.secho(f"The above config is extracted from {config_path}")
 
     if locate:
         click.launch(str(config_path.parent))
 
 
-
 @dataherb.command()
-@click.argument("keywords", required=False)
+@click.option(
+    "--flora",
+    "-f",
+    default=None,
+    help="Path to the flora file; Defaults to the default flora in the configuration.",
+)
 @click.option("--id", "-i", required=False, help="The id of the dataset to describe.")
-@click.option("--flora", "-f", default=None, help="Path to the flora file; Defaults to the default flora in the configuration.")
-def search(flora, id=None, keywords=None):
+@click.argument("keywords", required=False)
+@click.option(
+    "--full/--summary", default=False, help="Whether to show the full json result"
+)
+def search(flora, id, keywords, full):
     """
     search datasets on DataHerb by keywords or id
     """
     if flora is None:
         c = Config()
         flora = c.flora_path
 
-    SHOW_KEYS = ["name", "description", "contributors"]
     fl = Flora(flora=flora)
     if not id:
         click.echo("Searching Herbs in DataHerb Flora ...")
@@ -134,25 +149,63 @@ def search(flora, id=None, keywords=None):
             click.echo(f"Could not find dataset related to {keywords}")
         else:
             for result in results:
+                result_herb = result.get("herb")
                 result_metadata = result.get("herb").metadata
-                click.echo(f'DataHerb ID: {result_metadata.get("id")}')
-                click.echo(result_metadata)
+                if not full:
+                    ht = HerbTable(result_herb)
+                    console.rule(title=f"{result_herb.id}", characters="||")
+                    console.print(ht.table())
+                    console.print(ht.resource_tree())
+                else:
+                    console.rule(title=f"{result_herb.id}", characters="||")
+                    click.secho(f"DataHerb ID: {result_herb.id}")
+                    click.echo(json.dumps(result_metadata, indent=2, sort_keys=True))
     else:
         click.echo(f"Fetching Herbs {id} in DataHerb Flora ...")
         result = fl.herb(id)
         if not result:
             click.echo(f"Could not find dataset with id {id}")
         else:
             result_metadata = result.metadata
-            click.echo(f'DataHerb ID: {result_metadata.get("id")}')
-            click.echo(result_metadata)
+
+            if not full:
+                ht = HerbTable(result)
+                console.rule(title=f"{result.id}", characters="||")
+                console.print(ht.table())
+                console.print(ht.resource_tree())
+            else:
+                console.rule(title=f"{result.id}", characters="||")
+                click.secho(f"DataHerb ID: {result.id}")
+                click.echo(json.dumps(result_metadata, indent=2, sort_keys=True))
 
 
 @dataherb.command()
-@click.option("--flora", "-f", default=None, help="Specify the path to the flora; defaults to default flora in configuration.")
-@click.option("--workdir", "-w", default=None, help="Specify the path to the work directory; defaults to the workdir in configuration.")
-@click.option("--dev_addr", "-a", default="localhost:52125", metavar="<IP:PORT>", help="Specify the address of the dev server; defaults to localhost:52125")
-@click.option("--recreate", "-r", default=False, required=False, help="Whether to recreate the website. Recreation will delete all the current generated pages and rebuild the whole website.")
+@click.option(
+    "--flora",
+    "-f",
+    default=None,
+    help="Specify the path to the flora; defaults to default flora in configuration.",
+)
+@click.option(
+    "--workdir",
+    "-w",
+    default=None,
+    help="Specify the path to the work directory; defaults to the workdir in configuration.",
+)
+@click.option(
+    "--dev_addr",
+    "-a",
+    default="localhost:52125",
+    metavar="<IP:PORT>",
+    help="Specify the address of the dev server; defaults to localhost:52125",
+)
+@click.option(
+    "--recreate",
+    "-r",
+    default=False,
+    required=False,
+    help="Whether to recreate the website. Recreation will delete all the current generated pages and rebuild the whole website.",
+)
 def serve(flora, workdir, dev_addr, recreate):
     """
     create a dataherb server and view the flora in your browser
@@ -179,8 +232,18 @@ def serve(flora, workdir, dev_addr, recreate):
 
 @dataherb.command()
 @click.argument("id", required=True)
-@click.option("--flora", "-f", default=None, help="Specify the path to the flora; defaults to default flora in configuration.")
-@click.option("--workdir", "-w", default=None, help="Specify the path to the work directory; defaults to the workdir in configuration.")
+@click.option(
+    "--flora",
+    "-f",
+    default=None,
+    help="Specify the path to the flora; defaults to default flora in configuration.",
+)
+@click.option(
+    "--workdir",
+    "-w",
+    default=None,
+    help="Specify the path to the work directory; defaults to the workdir in configuration.",
+)
 def download(id, flora, workdir):
     """
     Download dataset using id
@@ -229,7 +292,12 @@ def download(id, flora, workdir):
     "A dataherb.json file will be created right here.\n"
     "Are you sure this is the correct path?"
 )
-@click.option("--flora", "-f", default=None, help="Specify the path to the flora; defaults to default flora in configuration.")
+@click.option(
+    "--flora",
+    "-f",
+    default=None,
+    help="Specify the path to the flora; defaults to default flora in configuration.",
+)
 def create(flora):
     """
     creates metadata for current dataset
@@ -266,7 +334,9 @@ def create(flora):
         md.metadata.update(pkg_descriptor)
 
         if (Path(__CWD__) / "dataherb.json").exists():
-            is_overwrite = click.confirm("Replace the current dataherb.json file?", default=False)
+            is_overwrite = click.confirm(
+                "Replace the current dataherb.json file?", default=False
+            )
             if is_overwrite:
                 md.create(overwrite=is_overwrite)
 
@@ -292,7 +362,12 @@ def create(flora):
 
 
 @dataherb.command()
-@click.option("--flora", "-f", default=None, help="Specify the path to the flora; defaults to default flora in configuration.")
+@click.option(
+    "--flora",
+    "-f",
+    default=None,
+    help="Specify the path to the flora; defaults to default flora in configuration.",
+)
 @click.argument("herb_id", required=True)
 def remove(flora, herb_id):
     """

dataherb/core/base.py

@@ -62,11 +62,12 @@ def _from_meta_dict(self, meta_dict):
         """Build properties from meta dict"""
         self.name = meta_dict.get("name")
         self.description = meta_dict.get("description")
-        self.repository = meta_dict.get("repository")
+        self.repository = meta_dict.get("repository")  # Deprecated
         self.id = meta_dict.get("id")
 
         self.source = meta_dict.get("source")
         self.metadata_uri = meta_dict.get("metadata_uri")
+        self.uri = meta_dict.get("uri")
         self.datapackage = Package(meta_dict.get("datapackage"))
         if not self.datapackage:
             self.update_datapackage()

dataherb/parse/model_json.py

@@ -62,15 +62,16 @@ def create(self, overwrite=False):
 
         metadata_file = self.metadata_file
 
-
         if os.path.isfile(os.path.join(dataherb_folder, metadata_file)):
             if not overwrite:
                 logger.error(
                     f"File {os.path.join(dataherb_folder, metadata_file)} already exists!"
                 )
                 raise SystemExit
             else:
-                logger.debug(f"Will overwrite {os.path.join(dataherb_folder, metadata_file)}")
+                logger.debug(
+                    f"Will overwrite {os.path.join(dataherb_folder, metadata_file)}"
+                )
 
         with open(os.path.join(dataherb_folder, metadata_file), "w") as fp:
             documents = json.dump(self.metadata, fp, indent=4)

dataherb/utils/configs.py

@@ -8,8 +8,8 @@
 
 
 class Config:
-    """Config system for Dataherb
-    """
+    """Config system for Dataherb"""
+
     def __init__(self, config_path=None, no_config_error=False):
 
         self.config_path = config_path
@@ -81,7 +81,9 @@ def workdir(self):
 
     @property
     def flora_path(self):
-        return self._flora_path(self.config.get("default", {}).get("flora"), self.config["workdir"])
+        return self._flora_path(
+            self.config.get("default", {}).get("flora"), self.config["workdir"]
+        )
 
     @property
     def flora(self):
@@ -94,4 +96,4 @@ def flora(self):
     print(c.config)
     print(c.flora_path)
     print(c.workdir)
-    print(c.flora)
+    print(c.flora)