Skip to content

Commit 835e9f9

Browse files
committed
Readme update, code updates
1 parent 4cce432 commit 835e9f9

File tree

3 files changed

+99
-107
lines changed

3 files changed

+99
-107
lines changed

README.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323

2424
## Installation
2525

26+
STAC API Validator requires Python 3.10 and [Poetry 1.2](https://python-poetry.org/docs/).
27+
2628
Install the package with development requirements:
2729

2830
```console
@@ -75,28 +77,34 @@ The parameters that filter results apply to the Items resource and Item Search e
7577

7678
The current validity status of several popular STAC API implementations can be found [here](../stac-api-validator/COMPLIANCE_REPORT.md).
7779

78-
## Running the validator
79-
80-
Running this requires Python 3.9.5.
80+
## Command-line Reference
8181

82-
Create new venv with python >= 3.9:
83-
84-
```
85-
pyenv local 3.9.5
86-
python -m venv --prompt stac-api-validator .venv
87-
source ./.venv/bin/activate
88-
```
89-
90-
Install dependencies:
82+
Usage:
9183

9284
```
93-
pip install -r requirements.txt
85+
Usage: stac-api-validator [OPTIONS]
86+
87+
STAC API Validator.
88+
89+
Options:
90+
--version Show the version and exit.
91+
--log-level TEXT Logging level, one of DEBUG, INFO, WARN,
92+
ERROR, CRITICAL
93+
--root-url TEXT STAC API Root / Landing Page URL [required]
94+
--post / --no-post Test all validations with POST method for
95+
requests in addition to GET
96+
--conformance [core|browseable|item-search|features|collections|children]
97+
Conformance class URIs to validate
98+
[required]
99+
--help Show this message and exit.
94100
```
95101

96-
Run:
102+
Example
97103

98104
```
99-
python stac_api_validator/validate.py --root https://cmr.earthdata.nasa.gov/stac/LARC_ASDC
105+
poetry run stac-api-validator \
106+
--root-url https://cmr.earthdata.nasa.gov/stac/LARC_ASDC \
107+
--conformance core --conformance item-search --conformance features
100108
```
101109

102110
Example output:
@@ -118,20 +126,6 @@ errors:
118126
Additionally, the `--no-post` option can be specified to only test GET requests, instead of the default of using
119127
both GET and POST.
120128

121-
Usage:
122-
123-
```
124-
usage: validate.py [-h] [--logging LOGGING] [--root ROOT] [--post | --no-post]
125-
126-
STAC API Validation Suite
127-
128-
optional arguments:
129-
-h, --help show this help message and exit
130-
--logging LOGGING DEBUG, INFO, WARN, ERROR, CRITICAL
131-
--root ROOT STAC API Root / Landing Page URL
132-
--post, --no-post Also use POST method for requests (default: True)
133-
```
134-
135129
## Validating OGC API Features - Part 1 compliance
136130

137131
A STAC API that conforms to the "STAC API - Features" conformance class will also be a valid implementation

poetry.lock

Lines changed: 13 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)