Merge pull request #184 from sparkgeo/stac_lint

Add linting option from stac-check

Author: jonhealy1

.github/workflows/publish-to-pypi.yml

@@ -33,7 +33,7 @@ jobs:
         --outdir dist/
 
     - name: Publish distribution to PyPI
-      if: startsWith(github.ref, 'refs/tags')
+      # if: startsWith(github.ref, 'refs/tags')
       uses: pypa/[email protected]
       with:
         password: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v2.4.0] - 2022-02-02
+### Added
+
+ - Linting option in cli to display stac-check generated information
 
 ## [v2.3.0] - 2021-08-31 - 2021-11-28
 ### Added

README.md

@@ -100,6 +100,7 @@ stac_validator --help
 Usage: stac_validator [OPTIONS] STAC_FILE
 
 Options:
+  --lint                   Use stac-check to lint stac object.
   --core                   Validate core stac object only without extensions.
   --extensions             Validate extensions only.
   --links                  Additionally validate links. Only works with
@@ -111,6 +112,7 @@ Options:
   -r, --recursive INTEGER  Recursively validate all related stac objects. A
                            depth of -1 indicates full recursion.
   -v, --verbose            Enables verbose output for recursive mode.
+  --no_output              Do not print output to console.
   --log_file TEXT          Save full recursive output to log file (local
                            filepath).
   --version                Show the version and exit.

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-__version__ = "2.3.0"
+__version__ = "2.4.0"
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
@@ -35,6 +35,7 @@
         "jsonschema>=3.2.0",
         "pystac[validation]==1.1.0",
         "click>=8.0.0",
+        "stac-check==1.0.2",
     ],
     packages=["stac_validator"],
     entry_points={

stac_validator/__init__.py

@@ -1 +1 @@
-__version__ = "2.3.0"
+__version__ = "2.4.0"

stac_validator/stac_validator.py

@@ -2,12 +2,15 @@
 import sys
 
 import click  # type: ignore
+from stac_check.cli import cli_message as lint_message  # type: ignore
+from stac_check.lint import Linter  # type: ignore
 
 from .validate import StacValidate
 
 
 @click.command()
 @click.argument("stac_file")
+@click.option("--lint", is_flag=True, help="Use stac-check to lint stac object.")
 @click.option(
     "--core", is_flag=True, help="Validate core stac object only without extensions."
 )
@@ -47,6 +50,7 @@
 @click.version_option(version="2.2.0")
 def main(
     stac_file,
+    lint,
     recursive,
     core,
     extensions,
@@ -57,25 +61,30 @@ def main(
     no_output,
     log_file,
 ):
-    stac = StacValidate(
-        stac_file=stac_file,
-        recursive=recursive,
-        core=core,
-        links=links,
-        assets=assets,
-        extensions=extensions,
-        custom=custom,
-        verbose=verbose,
-        no_output=no_output,
-        log=log_file,
-    )
-    stac.run()
 
-    if no_output is False:
-        click.echo(json.dumps(stac.message, indent=4))
+    if lint is True:
+        linter = Linter(stac_file, assets=True, links=True, recursive=False)
+        lint_message(linter)
+    else:
+        stac = StacValidate(
+            stac_file=stac_file,
+            recursive=recursive,
+            core=core,
+            links=links,
+            assets=assets,
+            extensions=extensions,
+            custom=custom,
+            verbose=verbose,
+            no_output=no_output,
+            log=log_file,
+        )
+        stac.run()
 
-    if recursive == -2 and stac.message[0]["valid_stac"] is False:
-        sys.exit(1)
+        if no_output is False:
+            click.echo(json.dumps(stac.message, indent=4))
+
+        if recursive == -2 and stac.message[0]["valid_stac"] is False:
+            sys.exit(1)
 
 
 if __name__ == "__main__":