get plot and hist commands working again

stac-utils · Oct 31, 2023 · 48d48a7 · 48d48a7
1 parent 5dd60bc
commit 48d48a7
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 57 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [v0.2.0-rc.2] - 2023-10-31
+## [v0.2.0rc4] - 2023-10-31
+
+### Fixed
+
+- Histograms would not draw due to removed `plot.clp()` method
+
+### Removed
+
+- Support for passing input item collection as command argument: input is now
+  always via stdin, use file redirection instead
+
+## [v0.2.0rc3] - 2023-10-31
 
 ### Added
 
@@ -46,7 +57,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Initial release.
 
-[Unreleased]: <https://github.com/stac-utils/stac-terminal/compare/v0.2.0-rc.2...main>
-[v0.2.0-rc.2]: <https://github.com/stac-utils/stac-terminal/compare/v0.2.0-rc.1...v0.2.0-rc.2>
+[Unreleased]: <https://github.com/stac-utils/stac-terminal/compare/v0.2.0-rc.4...main>
+[v0.2.0rc4]: <https://github.com/stac-utils/stac-terminal/compare/v0.2.0-rc.1...v0.2.0rc4>
+[v0.2.0rc3]: <https://github.com/stac-utils/stac-terminal/compare/v0.2.0-rc.1...v0.2.0rc3>
 [v0.2.0-rc.1]: <https://github.com/stac-utils/stac-terminal/compare/v0.1.0...v0.2.0-rc.1>
 [v0.1.0]: <https://github.com/stac-utils/stac-terminal/tree/v0.1.0>
diff --git a/README.md b/README.md
@@ -1,23 +1,29 @@
 # stacterm
 
-This library is for displaying information (tables, calendars, plots, histograms) about [STAC](https://stacspec.org/) Items in the terminal. It takes as input a STAC ItemCollection (a GeoJSON FeatureCollection of STAC Items), either by specifying a filename or by piping output from another program.
+This library is for displaying information (tables, calendars, plots,
+histograms) about [STAC](https://stacspec.org/) Items in the terminal. It takes
+as input a STAC ItemCollection (a GeoJSON FeatureCollection of STAC Items),
+either by specifying a filename or by piping output from another program.
 
 ## Installation
 
 Install from PyPi:
 
-```
-$ pip install stacterm
+```cmdline
+❯ pip install stacterm
 ```
 
-PySTAC and Pandas are required, along with two dependencies for rendering tables ([termtables](https://pypi.org/project/termtables/)) and plots ([plotext](https://pypi.org/project/plotext/)) in the terminal.
+PySTAC and Pandas are required, along with two dependencies for rendering
+tables ([termtables](https://pypi.org/project/termtables/)) and plots
+([plotext](https://pypi.org/project/plotext/)) in the terminal.
 
 ## Usage
 
-stacterm main usage is as a CLI progam `stacterm`. Use help to see options available:
+stacterm main usage is as a CLI progam `stacterm`. Use help to see options
+available:
 
-```
-$ stacterm -h
+```cmdline
+❯ stacterm -h
 usage: stacterm [-h] {table,cal,hist,plot} ...
 
 Terminal STAC
@@ -33,7 +39,8 @@ optional arguments:
   -h, --help            show this help message and exit
 ```
 
-All of the sub-commands in `stacterm` can take optional field names. A field name is:
+All of the sub-commands in `stacterm` can take optional field names. A field
+name is:
 
 - `id`: The ID of the Item
 - `collection`: The collection of the Item
@@ -43,22 +50,27 @@ All of the sub-commands in `stacterm` can take optional field names. A field nam
   - `year`: The year of the Item's `datetime` field
 - Any property
 
-The detailed usage examples below are shown using a saved file, however `stacterm` can also read in stdin allowing other programs to pipe output to it, such as [pystac-client](https://github.com/stac-utils/pystac-client).
+`stacterm` reads from in stdin allowing other programs to pipe output to it,
+such as [pystac-client](https://github.com/stac-utils/pystac-client).
 
-```
-$ export STAC_API_URL=https://earth-search.aws.element84.com/v0
-$ stac-client search --intersects aoi.json --datetime 2020-07-01/2020-12-31 -c sentinel-s2-l2a-cogs landsat-8-l1-c1 | stacterm cal --label platform
+```cmdline
+❯ export STAC_API_URL=https://earth-search.aws.element84.com/v0
+❯ stac-client search --intersects aoi.json \
+    --datetime 2020-07-01/2020-12-31 \
+    -c sentinel-s2-l2a-cogs landsat-8-l1-c1 | stacterm cal --label platform
 ```
 
-![](images/cal.png)
+The detailed usage examples below are all shown using the item collection from
+a search saved to a file and redirected to stdin.
 
+![](images/cal.png)
 
 ### Tables
 
 Use `stacterm` to display tabularized data from a saved ItemCollection.
 
-```
-$ stacterm table items.json
+```cmdline
+❯ <input.json stacterm table
 
 | id                                       | date       |
 |------------------------------------------|------------|
@@ -75,10 +87,13 @@ By default this is a markdown table (note the terminal will not render Markdown)
 | LC08_L1TP_026079_20201115_20201210_01_T1 | 2020-11-15 |
 | S2A_12JXQ_20201008_0_L1C                 | 2020-10-08 |
 
-The fields displayed can be changed via the `--fields` keyword, and sorted via the `--sort` keyword.
+The fields displayed can be changed via the `--fields` keyword, and sorted via
+the `--sort` keyword.
 
-```
-$ stacterm table items.json --fields date eo:cloud_cover collection --sort eo:cloud_cover
+```cmdline
+❯ <input.json stacterm table \
+    --fields date eo:cloud_cover collection \
+    --sort eo:cloud_cover
 
 | date       | eo:cloud_cover | collection           |
 |------------|----------------|----------------------|
@@ -88,71 +103,93 @@ $ stacterm table items.json --fields date eo:cloud_cover collection --sort eo:cl
 | 2020-10-13 | 0.0            | sentinel-s2-l1c      |
 ```
 
-The style of the table can also be changed via the `--style` keyword, although it will no longer be usable in a Markdown renderer. See [termtables styles](https://github.com/nschloe/termtables/blob/master/termtables/styles.py) for list of styles.
+The style of the table can also be changed via the `--style` keyword, although
+it will no longer be usable in a Markdown renderer. See [termtables
+styles](https://github.com/nschloe/termtables/blob/master/termtables/styles.py)
+for list of styles.
 
-```
-$ stacterm table items.json --fields id date platform sentinel:grid_square --sort date --style thick
-
-┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┓
-┃ id                                       ┃ date       ┃ platform    ┃ sentinel:grid_square ┃
-┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
-┃ S2B_12JXR_20201003_0_L2A                 ┃ 2020-10-03 ┃ sentinel-2b ┃ XR                   ┃
-┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
-┃ S2B_12JXQ_20201003_0_L1C                 ┃ 2020-10-03 ┃ sentinel-2b ┃ XQ                   ┃
-┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
-┃ S2B_12JXQ_20201003_0_L2A                 ┃ 2020-10-03 ┃ sentinel-2b ┃ XQ                   ┃
-┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━━━━━━━┻━━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━┛
+```cmdline
+❯ <input.json stacterm table \
+    --fields id date platform sentinel:grid_square\
+    --sort date \
+    --style thick
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┓
+┃ id                        ┃ date       ┃ platform    ┃ sentinel:grid_square ┃
+┣━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
+┃ S2B_12JXR_20201003_0_L2A  ┃ 2020-10-03 ┃ sentinel-2b ┃ XR                   ┃
+┣━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
+┃ S2B_12JXQ_20201003_0_L1C  ┃ 2020-10-03 ┃ sentinel-2b ┃ XQ                   ┃
+┣━━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━┫
+┃ S2B_12JXQ_20201003_0_L2A  ┃ 2020-10-03 ┃ sentinel-2b ┃ XQ                   ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━━━━━━━┻━━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━┛
 ```
 
 ### Calendars
 
-A UNIX-like calendar (see [`cal`](https://en.wikipedia.org/wiki/Cal_(Unix))) is available to show dates of individual items. By default `cal` will use the field `datetime` (the collection datetime) and group Items by their Collection. These can be overridden by the `--date_field` and `--label_field` keywords. Note that the specified `--date_field` needs to be a date field, such as `created` or `updated`.  `--label_field` will group and label items by the provided field.
+A UNIX-like calendar (see [`cal`](https://en.wikipedia.org/wiki/Cal_(Unix))) is
+available to show dates of individual items. By default `cal` will use the
+field `datetime` (the collection datetime) and group Items by their Collection.
+These can be overridden by the `--date_field` and `--label_field` keywords.
+Note that the specified `--date_field` needs to be a date field, such as
+`created` or `updated`.  `--label_field` will group and label items by the
+provided field.
 
-```
-$ stacterm cal items.json --date_field created --label_field gsd
+```cmdline
+❯ <input.json stacterm cal --date_field created --label_field gsd
 ```
 
 ![](images/cal2.png)
 
 ### Histograms
 
-Histograms can be created for any numeric field and `datetime` and `date` (just the date portion of `datetime`). `created` and `updated` may also be specified if available in all Items.
+Histograms can be created for any numeric field and `datetime` and `date` (just
+the date portion of `datetime`). `created` and `updated` may also be specified
+if available in all Items.
 
-```
-$ stacterm hist items.json eo:cloud_cover
+```cmdline
+❯ <items.json stacterm hist eo:cloud_cover
 ```
 
 ![](images/hist.png)
 
 ### Plots
 
-Plots can be created with a single numeric fields, a date field (`datetime`, `date`, `created`, or `updated`) and a numeric field, or two numeric fields. If a single field it will be plotted against the scene number. The `--sort` keyword can control how to sort the data if plotting a single field.
+Plots can be created with a single numeric fields, a date field (`datetime`,
+`date`, `created`, or `updated`) and a numeric field, or two numeric fields. If
+a single field it will be plotted against the scene number. The `--sort`
+keyword can control how to sort the data if plotting a single field.
 
-```
-$ stacterm plot items.json eo:cloud_cover --sort eo:cloud_cover
+```cmdline
+❯ <input.json stacterm plot eo:cloud_cover --sort eo:cloud_cover
 ```
 
 ![](images/plot.png)
 
-
 ## Markers and Colors
 
-For histograms and plots there are options for changing the marker (symbol) and color of the plot, background, and text. These options all come directly from [plotext](https://github.com/piccolomo/plotext).
+For histograms and plots there are options for changing the marker (symbol) and
+color of the plot, background, and text. These options all come directly from
+[plotext](https://github.com/piccolomo/plotext).
 
-In addition to a marker being able to be any single character, the following names can also be provided for these symbols:
+In addition to a marker being able to be any single character, the following
+names can also be provided for these symbols:
 
 ![](https://raw.githubusercontent.com/piccolomo/plotext/master/images/markers.png)
 
 Color names can be provided as follows:
 
 ![](https://raw.githubusercontent.com/piccolomo/plotext/master/images/colors.png)
 
-
 ## Limitations
 
 Currently any provided field must exist in all STAC Items.
 
-
 ## Development
 
-There are a lot more options in the [plotext library](https://github.com/piccolomo/plotext) that could be surfaced here. Additionally, if [support for datetimes](https://github.com/piccolomo/plotext/issues/7) in histograms and plots is added, `stacterm` could create temporal histograms, or plot quantities vs date.
+There are a lot more options in the [plotext
+library](https://github.com/piccolomo/plotext) that could be surfaced here.
+Additionally, if [support for
+datetimes](https://github.com/piccolomo/plotext/issues/7) in histograms and
+plots is added, `stacterm` could create temporal histograms, or plot quantities
+vs date.
diff --git a/src/stacterm/cli.py b/src/stacterm/cli.py
@@ -1,6 +1,5 @@
 import argparse
 import json
-import os
 import sys
 
 from .calendar import print_calendar
@@ -22,7 +21,6 @@ def parse_args(args):
         action="version",
         version=__version__,
     )
-    parent.add_argument("items", nargs="?", default=sys.stdin)
 
     subparsers = parser0.add_subparsers(dest="command")
 
@@ -93,11 +91,7 @@ def parse_args(args):
     parsed_args = {
         k: v for k, v in vars(parser0.parse_args(args)).items() if v is not None
     }
-    if not sys.stdin.isatty():
-        parsed_args["items"] = json.load(parsed_args["items"])
-    elif os.path.exists(parsed_args["items"]):
-        with open(parsed_args["items"]) as f:
-            parsed_args["items"] = json.loads(f.read())
+    parsed_args["items"] = json.load(sys.stdin)
     return parsed_args
 
 

diff --git a/src/stacterm/histogram.py b/src/stacterm/histogram.py
@@ -15,7 +15,6 @@ def print_histogram(
     axes_color=None,
 ):
     df = items_to_dataframe(items)
-    plt.clp()
 
     data = df["timestamp"] if field in DATE_FIELDS else df[field]