readabs.print_abs_catalogue

Print the ABS Catalogue of time-series data.

 1"""Print the ABS Catalogue of time-series data."""
 2
 3from readabs.abs_catalogue import abs_catalogue
 4
 5
 6def print_abs_catalogue(cache_only=False, verbose=False) -> None:
 7    """This function prints to standard output a table of the ABS
 8    Catalogue Numbers that contain time-series data. In addition to the
 9    Catalogue Numbers, the table includes the theme, parent topic and
10    topic for the collection represented by each Catalogue Number.
11
12    It is primarily a convenience function: The first parameter for
13    the read_abs_cat() and read_abs_series() functions is the ABS
14    Catalogue Number from which data is sought.
15
16    Parameters
17    ----------
18    cache_only : bool = False
19        If True, only use the cache.
20    verbose : bool = False
21        If True, print progress messages.
22
23    Return values
24    -------------
25
26    The function does not return anything.
27
28    Example
29    -------
30
31    ```python
32    import readabs as ra
33    ra.print_abs_catalogue()
34    ```"""
35
36    catalogue = abs_catalogue(cache_only=cache_only, verbose=verbose)
37    print(catalogue.loc[:, catalogue.columns != "URL"].to_markdown())
38
39
40if __name__ == "__main__":
41    print_abs_catalogue()