Merge pull request #230 from berquist/console-updates

Fix help text for second NetCDF file passed on command line

CHANGELOG.md

@@ -4,22 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [unreleased]
+## [1.9.0]
 ### Added
 - [Issue #210](https://github.com/nasa/ncompare/issues/210): Add gif of usage to readme
 ### Changed
-- [Issue #184](https://github.com/nasa/ncompare/issues/184): changed license to Apache License 2.0.
+- [Issue #184](https://github.com/nasa/ncompare/issues/184): Change license to Apache License 2.0. and include copyright header text
 - [Issue #200](https://github.com/nasa/ncompare/issues/200): Change dependabot frequency to monthly
-- [Issue #200](https://github.com/nasa/ncompare/issues/200): Add copyright header text
 ### Deprecated
 ### Removed
 ### Fixed
 - [Issue #208](https://github.com/nasa/ncompare/issues/208): Fix missing group error
-- [Pull #190](https://github.com/nasa/ncompare/pull/190): codecov upload token error
+- [Pull #190](https://github.com/nasa/ncompare/pull/190): Fix codecov upload token error
 - [Pull #199](https://github.com/nasa/ncompare/pull/199): Resolve linting error
 ### Security
 
-## [1.8.0]
+## [1.8.0] - 2024-03-12
 ### Added
 ### Changed
 - update dependencies
@@ -30,7 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.3]
+## [1.7.3] - 2024-02-06
 ### Added
 ### Changed
 - add Zenodo badge to readme
@@ -39,7 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.2]
+## [1.7.2] - 2024-02-06
 ### Added
 ### Changed
 - add pyOpenSci badge to readme
@@ -48,7 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.1]
+## [1.7.1] - 2024-02-06
 ### Added
 ### Changed
 - update dependencies
@@ -58,7 +57,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.7.0]
+## [1.7.0] - 2024-02-06
 ### Added
 ### Changed
 - [pull/136](https://github.com/nasa/ncompare/pull/136): Replace data in example notebook with those requiring no credentials
@@ -68,7 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull/135](https://github.com/nasa/ncompare/pull/135): Fix links in readme
 ### Security
 
-## [1.6.2]
+## [1.6.2] - 2024-01-16
 ### Added
 ### Changed
 - updated PyPI classifiers in pyproject.toml
@@ -77,7 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.6.1]
+## [1.6.1] - 2024-01-16
 ### Added
 ### Changed
 ### Deprecated
@@ -87,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - [pull-request/125](https://github.com/nasa/ncompare/pull/125): Bump jinja2 from 3.1.2 to 3.1.3
 
-## [1.6.0]
+## [1.6.0] - 2024-01-16
 ### Added
 - [pull-request/79](https://github.com/nasa/ncompare/pull/79): Add option to only display variables and attributes that are different
 - [pull-request/100](https://github.com/nasa/ncompare/pull/100): Add version to cli
@@ -108,7 +107,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated out-dated example snippet in README
 ### Security
 
-## [1.5.0]
+## [1.5.0] - 2023-10-25
 ### Added
 - [pull-request/63](https://github.com/nasa/ncompare/pull/59): Add a tutorial example notebook.
 - Added a simple GitHub Pages that links to an quarto-produced version of the tutorial notebook.
@@ -118,7 +117,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.4.0]
+## [1.4.0] - 2023-10-23
 ### Added
 - [pull-request/59](https://github.com/nasa/ncompare/pull/59): Add the ability to modify the width of each column in the comparison table.
 ### Changed
@@ -128,7 +127,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull-request/60](https://github.com/nasa/ncompare/pull/60): Removes an extra line of printed filepaths.
 ### Security
 
-## [1.3.0]
+## [1.3.0] - 2023-10-20
 ### Added
 ### Changed
 ### Deprecated
@@ -137,7 +136,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [pull-request/55](https://github.com/nasa/ncompare/pull/55): Fix variable value matching
 ### Security
 
-## [1.2.0]
+## [1.2.0] - 2023-10-11
 ### Added
 - [pull-request/44](https://github.com/nasa/ncompare/pull/44): Added issue templates and markdown guides for CONTRIBUTING and the CODE_OF_CONDUCT
 ### Changed
@@ -147,7 +146,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.1.0]
+## [1.1.0] - 2023-09-26
 ### Added
 - [commit/4b98808](https://github.com/nasa/ncompare/commit/4b98808cf3d8424da25a226687d304ce7d46738e): Set up dependabot for automated version updates
 ### Changed
@@ -157,23 +156,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-## [1.0.2]
+## [1.0.2] - 2023-09-20
 ### Added
-- [issue/19](https://github.com/nasa/ncompare/issues/19): Add automated publishing (via poetry) to TestPyPI and PyPI in Actions workflow
+- Add automated publishing (via poetry) to TestPyPI and PyPI in Actions workflow [issue/19](https://github.com/nasa/ncompare/issues/19)
 ### Changed
-- [issue/23](https://github.com/nasa/ncompare/issues/23): Use ruff and black for linting and formatting
+- Use ruff and black for linting and formatting [issue/23](https://github.com/nasa/ncompare/issues/23)
 ### Deprecated
 ### Removed
 ### Fixed
 ### Security
 
-## [1.0.1]
+## [1.0.1] - 2023-09-06
 ### Added
 ### Changed
-- [issue/12](https://github.com/nasa/ncompare/issues/12): Improve test suite
-- [issue/13](https://github.com/nasa/ncompare/issues/13): Enable `ncompare` to work with greater group depths
+- Improve test suite [#12](https://github.com/nasa/ncompare/issues/12):
+- Enable `ncompare` to work with greater group depths [#13](https://github.com/nasa/ncompare/issues/13):
 ### Deprecated
 ### Removed
 ### Fixed
-- [issue/5](https://github.com/nasa/ncompare/issues/5): Fix author attribute for poetry
+- Fix author attribute for poetry [#5](https://github.com/nasa/ncompare/issues/5)
 ### Security

CITATION.cff

@@ -18,8 +18,8 @@ keywords:
 url: "https://ncompare.readthedocs.io"
 repository-code: "https://github.com/nasa/ncompare"
 
-version: 1.8.0
-date-released: 2024-02-06
+version: 1.9.0
+date-released: 2024-05-29
 
 authors:
 - family-names: "Baskin"

ncompare/console.py

@@ -29,13 +29,15 @@
 import importlib.metadata
 import sys
 import traceback
+from collections.abc import Sequence
+from typing import Optional
 
 from ncompare.core import compare
 
 __version__ = importlib.metadata.version('ncompare')
 
 
-def _cli(args) -> argparse.Namespace:
+def _cli(args: Optional[Sequence[str]]) -> argparse.Namespace:
     """Parse input arguments from the command line.
 
     Parameters
@@ -47,7 +49,7 @@ def _cli(args) -> argparse.Namespace:
         description="Compare the variables contained within two different NetCDF datasets"
     )
     parser.add_argument("nc_a", help="First NetCDF file")
-    parser.add_argument("nc_b", help="First NetCDF file")
+    parser.add_argument("nc_b", help="Second NetCDF file")
     parser.add_argument("-v", "--comparison_var_name", help="Comparison variable name")
     parser.add_argument("-g", "--comparison_var_group", help="Comparison variable group")
     parser.add_argument(
@@ -97,7 +99,7 @@ def _cli(args) -> argparse.Namespace:
     return parser.parse_args(args)
 
 
-def main():  # pragma: no cover
+def main() -> None:  # pragma: no cover
     """Run from the command line."""
     args = _cli(None)