Merge pull request #411 from sjsrey/remote

Return a dataframe with info on available datasets

Author: sjsrey

ci/36.yaml

@@ -4,6 +4,7 @@ channels:
 dependencies:
   - python=3.6
   - beautifulsoup4
+  - jinja2
   - pandas>=1.0
   - scipy>=1.0
   - xarray

ci/37.yaml

@@ -4,6 +4,7 @@ channels:
 dependencies:
   - python=3.7
   - beautifulsoup4
+  - jinja2
   - pandas>=1.0
   - scipy>=1.0
   - xarray

ci/38.yaml

@@ -4,6 +4,7 @@ channels:
 dependencies:
   - python=3.8
   - beautifulsoup4
+  - jinja2
   - pandas>=1.0
   - scipy>=1.0
   - xarray

libpysal/examples/__init__.py

@@ -2,6 +2,8 @@
     example datasets as well as functions to fetch larger datasets.
 """
 
+
+import pandas as pd
 from .base import example_manager
 from .remotes import datasets as remote_datasets
 from .builtin import datasets as builtin_datasets
@@ -20,7 +22,6 @@ def fetch_all():
     names = list(datasets.keys())
     names.sort()
     for name in names:
-        print(name)
         example = datasets[name]
         try:
             example.download()
@@ -29,8 +30,8 @@ def fetch_all():
     example_manager.add_examples(datasets)
 
 
-def available() -> str:
-    """List available datasets."""
+def available() -> pd.DataFrame:
+    """Return a dataframe with available datasets."""
     fetch_all()
 
     return example_manager.available()

libpysal/examples/base.py

@@ -148,7 +148,7 @@ def get_path(self, file_name, verbose=True) -> Union[str, None]:
             if file_name == base_name:
                 return file_path
         if verbose:
-            print("{} is not a file in this example".format(file_name))
+            print(f'{file_name} is not a file in this example.')
         return None
 
     def downloaded(self) -> bool:
@@ -179,9 +179,7 @@ def explain(self) -> None:
     def download(self, path=get_data_home()):
         """Download the files for the example."""
 
-        if self.downloaded():
-            print("Already downloaded")
-        else:
+        if not self.downloaded():
             request = requests.get(self.download_url)
             archive = zipfile.ZipFile(io.BytesIO(request.content))
             target = join(path, self.root)
@@ -231,7 +229,7 @@ def explain(self, example_name) -> str:
             print("not available")
 
     def available(self):
-        """Report available datasets."""
+        """Return df of available datasets."""
         datasets = self.datasets
         names = list(datasets.keys())
         names.sort()
@@ -244,7 +242,7 @@ def available(self):
             data=rows, columns=["Name", "Description", "Installed"]
         )
         datasets.style.set_properties(subset=["text"], **{"width": "300px"})
-        print(datasets.to_string(max_colwidth=60))
+        return datasets
 
     def load(self, example_name: str) -> Example:
         """Load example dataset, download if not locally available."""
@@ -253,11 +251,10 @@ def load(self, example_name: str) -> Example:
             if example.installed:
                 return example
             else:
-                "Downloading: {}".format(example_name)
                 example.download()
                 return example
         else:
-            print("Example not available: {}".format(example_name))
+            print(f'Example not available: {example_name}')
             return None
 
     def download_remotes(self):
@@ -271,7 +268,7 @@ def download_remotes(self):
             try:
                 example.download()
             except:
-                print("Example not downloaded: {}".format(name))
+                print(f'Example not downloaded: {name}.')
 
     def get_installed_names(self) -> list:
         """Return names of all currently installed datasets."""

libpysal/examples/tests/test_available.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3
+
+import os
+import unittest
+import numpy as np
+import pandas
+
+from .. import available
+
+class Testavailable(unittest.TestCase):
+
+    def test_available(self):
+        examples = available()
+        self.assertEqual(type(examples), pandas.core.frame.DataFrame)
+
+
+suite = unittest.TestLoader().loadTestsFromTestCase(Testavailable)
+
+if __name__ == "__main__":
+    runner = unittest.TextTestRunner()
+    runner.run(suite)