cli docs

arcovid19.py

@@ -32,6 +32,7 @@
 # =============================================================================
 
 import os
+import sys
 import datetime as dt
 
 import logging
@@ -593,8 +594,9 @@ def _load_cases(*, url=CASES_URL, nocached=False, out=None):
         url: str
             The url for the excel table to parse. Default is ivco19 team table.
 
-        out: PATH
-            The output path to the CSV file
+        out: PATH (default=stdout)
+            The output path to the CSV file. If it's not provided the
+            data is printed in the stdout.
 
         nocached:
             If you want to ignore the local cache or retrieve a new value.
@@ -604,7 +606,7 @@ def _load_cases(*, url=CASES_URL, nocached=False, out=None):
         if out is not None:
             cases.to_csv(out)
         else:
-            print(cases)
+            cases.to_csv(sys.stdout)
     run(_load_cases)
 
 

docs/source/index.rst

@@ -97,6 +97,7 @@ Contents:
     :maxdepth: 2
 
     install/install.rst
+    install/cli.rst
     tutorial/tutorial.rst
     api/modules.rst
 

docs/source/install/cli.rst

@@ -0,0 +1,29 @@
+Command line interface (CLI)
+============================
+
+After install arcovid19 you also have a command line app to download the
+data as csv.
+
+.. code-block:: console
+
+    $ arcovid19 --help
+    Usage: arcovid19 [OPTIONS]
+
+    Retrieve and store the database as an as CSV file.
+
+    Options:
+    --url=STR    str The url for the excel table to parse. Default is ivco19 team table. (default: https://github.com/ivco19/libs/raw/master/databases/cases.xlsx)
+    --out=STR    PATH (default=stdout) The output path to the CSV file. If it's not provided the data is printed in the stdout.
+    --nocached   If you want to ignore the local cache or retrieve a new value.
+
+    Other actions:
+    -h, --help   Show the help
+
+
+
+
+
+
+
+
+

docs/source/install/install.rst

@@ -41,3 +41,4 @@ This will create a directory libs in your current directory.
 
 
 
+