Create configuration file option

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

@@ -1,37 +1,37 @@
-name: Publish Python distributions to PyPI
+# name: Publish Python distributions to PyPI
 
-on:
-  push:
-    branches:
-      - main
+# on:
+#   push:
+#     branches:
+#       - main
 
-jobs:
-  build-n-publish:
-    name: Build and publish Python distributions to PyPI and TestPyPI
-    runs-on: ubuntu-18.04
+# jobs:
+#   build-n-publish:
+#     name: Build and publish Python distributions to PyPI and TestPyPI
+#     runs-on: ubuntu-18.04
 
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.8
+#     steps:
+#     - uses: actions/checkout@master
+#     - name: Set up Python 3.8
+#       uses: actions/setup-python@v1
+#       with:
+#         python-version: 3.8
 
-    - name: Install pypa/build
-      run: >-
-        python -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-    - name: Publish distribution to PyPI
-      # if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@v1.4.2
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
+#     - name: Install pypa/build
+#       run: >-
+#         python -m
+#         pip install
+#         build
+#         --user
+#     - name: Build a binary wheel and a source tarball
+#       run: >-
+#         python -m
+#         build
+#         --sdist
+#         --wheel
+#         --outdir dist/
+#     - name: Publish distribution to PyPI
+#       # if: startsWith(github.ref, 'refs/tags')
+#       uses: pypa/gh-action-pypi-publish@v1.4.2
+#       with:
+#         password: ${{ secrets.PYPI_API_TOKEN }}

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

@@ -1,38 +1,38 @@
-name: Publish Python distributions to PyPI
+# name: Publish Python distributions to PyPI
 
-on:
-  push:
-    branches:
-      - dev
+# on:
+#   push:
+#     branches:
+#       - dev
 
-jobs:
-  build-n-publish:
-    name: Build and publish Python distributions to PyPI and TestPyPI
-    runs-on: ubuntu-18.04
+# jobs:
+#   build-n-publish:
+#     name: Build and publish Python distributions to PyPI and TestPyPI
+#     runs-on: ubuntu-18.04
 
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.8
+#     steps:
+#     - uses: actions/checkout@master
+#     - name: Set up Python 3.8
+#       uses: actions/setup-python@v1
+#       with:
+#         python-version: 3.8
 
-    - name: Install pypa/build
-      run: >-
-        python -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-    - name: Publish distribution to Test PyPI
-      # if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@v1.4.2
-      with:
-        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-        repository_url: https://test.pypi.org/legacy/
+#     - name: Install pypa/build
+#       run: >-
+#         python -m
+#         pip install
+#         build
+#         --user
+#     - name: Build a binary wheel and a source tarball
+#       run: >-
+#         python -m
+#         build
+#         --sdist
+#         --wheel
+#         --outdir dist/
+#     - name: Publish distribution to Test PyPI
+#       # if: startsWith(github.ref, 'refs/tags')
+#       uses: pypa/gh-action-pypi-publish@v1.4.2
+#       with:
+#         password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+#         repository_url: https://test.pypi.org/legacy/

CHANGELOG.md

@@ -4,6 +4,12 @@ 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/).
 
+## [Unreleased] - 
+### Added
+- Option to include a configuration file to ignore selected checks
+### Changed
+- Change name from stac_check to stac-check in setup for cli
+
 ## [v1.1.3] - 2022-03-03
 - Fix thumbnail size check
 

README.md

@@ -14,7 +14,7 @@ or for local development
 ---
 ### Usage
 ```
-Usage: stac_check [OPTIONS] FILE
+Usage: stac-check [OPTIONS] FILE
 
 Options:
   --version        Show the version and exit.
@@ -33,7 +33,7 @@ $ make shell
 ---
 ### Examples
 
-``` stac_check https://raw.githubusercontent.com/stac-utils/pystac/main/tests/data-files/examples/0.9.0/collection-spec/examples/landsat-collection.json --recursive ```
+``` stac-check https://raw.githubusercontent.com/stac-utils/pystac/main/tests/data-files/examples/0.9.0/collection-spec/examples/landsat-collection.json --recursive ```
 ```
  ____  ____  __    ___       ___  _  _  ____  ___  __ _ 
 / ___)(_  _)/ _\  / __)___  / __)/ )( \(  __)/ __)(  / )
@@ -68,7 +68,7 @@ Recursive validation error message:
 This object has 4 links
 ```
 
-``` stac_check sample_files/0.9.0/landsat8-sample.json```
+``` stac-check sample_files/0.9.0/landsat8-sample.json```
 
 <pre><b>stac-check: STAC spec validaton and linting tool</b>
 
@@ -96,7 +96,7 @@ STAC Best Practices:
 This object has 4 links
 </pre>
 
-``` stac_check sample_files/1.0.0/core-item.json --assets```    
+``` stac-check sample_files/1.0.0/core-item.json --assets```    
 <pre>
 <b>stac-check: STAC spec validaton and linting tool</b>
 
@@ -131,7 +131,7 @@ This object has 4 links
 
 
 
-``` stac_check sample_files/1.0.0/core-item-bad-links.json --links --assets```    
+``` stac-check sample_files/1.0.0/core-item-bad-links.json --links --assets```    
 <pre>
 <b>stac-check: STAC spec validaton and linting tool</b>
 
@@ -173,7 +173,7 @@ LINK request errors:
 This object has 4 links
 </pre>
 
-``` stac_check sample_files/0.9.0/bad-item.json```    
+``` stac-check sample_files/0.9.0/bad-item.json```    
 <pre>
 <b>stac-check: STAC spec validaton and linting tool</b>
 

setup.py

@@ -11,7 +11,7 @@
     name="stac_check",
     version=__version__,
     description="Linting and validation tool for STAC assets",
-    url="https://github.com/jonhealy1/stac-check",
+    url="https://github.com/stac-utils/stac-check",
     packages=find_packages(exclude=("tests",)),
     include_package_data=True,
     install_requires=[
@@ -20,10 +20,11 @@
         "requests>=2.19.1",
         "jsonschema>=3.1.2b0",
         "pytest",
-        "stac-validator>=2.4.2"
+        "stac-validator>=2.4.2",
+        "PyYAML"
     ],
     entry_points={
-        'console_scripts': ['stac_check=stac_check.cli:main']
+        'console_scripts': ['stac-check=stac_check.cli:main']
     },
     author="Jonathan Healy",
     author_email="jonathan.d.healy@gmail.com",

stac-check.config.yml

@@ -0,0 +1,27 @@
+linting:
+  # Identifiers should consist of only lowercase characters, numbers, '_', and '-'
+  searchable_identifiers: true
+  # Item name '{self.object_id}' should not contain ':' or '/'
+  percent_encoded: true
+  # Item file names should match their ids
+  item_id_file_name: true
+  # Collections and catalogs should be named collection.json and catalog.json
+  catalog_id_file_name: true
+  # A STAC collection should contain a summaries field
+  check_summaries: true
+  # Datetime fields should not be set to null
+  null_datetime: true
+  # best practices - check unlocated items to make sure bbox field is not set
+  check_unlocated: true
+  # best practices - recommend items have a geometry
+  check_geometry: true
+  # check to see if there are too many links
+  bloated_links: true
+  # best practices - check for bloated metadata in properties
+  bloated_metadata: true
+  # best practices - ensure thumbnail is a small file size ["png", "jpeg", "jpg", "webp"]
+  check_thumbnail: true
+  # best practices - ensure that links in catalogs and collections include a title field
+  links_title: true
+  # best practices - ensure that links in catalogs and collections include self link
+  links_self: true