Skip to content

Commit f3a5bdf

Browse files
committed
updates
1 parent e7132e3 commit f3a5bdf

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# stac-check
2+
23
## A linting and validation tool for STAC assets
34

45
The intent of this project is to provide a validation tool that also follows the official [STAC Best Practices document](https://github.com/radiantearth/stac-spec/blob/master/best-practices.md)
56

67
---
8+
79
### Documentation
10+
811
[stac-check.readthedocs.io](https://stac-check.readthedocs.io/en/latest/)
912

1013
---
14+
1115
### Install
16+
1217
`$ pip install stac-check`
1318

1419
or for local development
1520

1621
`$ pip install -e '.[dev]'`
1722

1823
---
24+
1925
### CLI Usage
26+
2027
```
2128
Usage: stac-check [OPTIONS] FILE
2229
@@ -34,14 +41,18 @@ Options:
3441
multiple times.
3542
--help Show this message and exit. Show this message and exit.
3643
```
44+
3745
---
46+
3847
### Docker
3948

4049
```
4150
$ make build
4251
$ make shell
4352
```
53+
4454
---
55+
4556
### Lint JSON
4657

4758
```
@@ -52,10 +63,13 @@ linter = Linter('<json_path>')
5263
for k, v in linter.create_best_practices_dict().items():
5364
print(k, ":", v)
5465
```
66+
5567
---
68+
5669
### CLI Examples
5770

58-
``` stac-check https://raw.githubusercontent.com/stac-utils/pystac/main/tests/data-files/examples/0.9.0/collection-spec/examples/landsat-collection.json --recursive ```
71+
`stac-check https://raw.githubusercontent.com/stac-utils/pystac/main/tests/data-files/examples/0.9.0/collection-spec/examples/landsat-collection.json --recursive`
72+
5973
```
6074
____ ____ __ ___ ___ _ _ ____ ___ __ _
6175
/ ___)(_ _)/ _\ / __)___ / __)/ )( \( __)/ __)( / )
@@ -64,7 +78,7 @@ for k, v in linter.create_best_practices_dict().items():
6478
6579
stac-check: STAC spec validation and linting tool
6680
67-
Please upgrade from version 0.9.0 to version 1.0.0!
81+
Please upgrade from version 0.9.0 to version 1.1.0!
6882
6983
Validator: stac-validator 3.5.0
7084
@@ -100,11 +114,11 @@ Error Message: Expecting value: line 1 column 1 (char 0)
100114
-------------------------
101115
```
102116

103-
``` stac-check sample_files/0.9.0/landsat8-sample.json```
117+
` stac-check sample_files/0.9.0/landsat8-sample.json`
104118

105119
<pre><b>stac-check: STAC spec validation and linting tool</b>
106120

107-
Please upgrade from version 0.9.0 to version 1.0.0!
121+
Please upgrade from version 0.9.0 to version 1.1.0!
108122

109123
Validator: stac-validator 3.5.0
110124

@@ -128,11 +142,12 @@ STAC Best Practices:
128142
This object has 4 links
129143
</pre>
130144

131-
``` stac-check sample_files/1.0.0/core-item.json --assets```
145+
` stac-check sample_files/1.0.0/core-item.json --assets`
146+
132147
<pre>
133148
<b>stac-check: STAC spec validation and linting tool</b>
134149

135-
Thanks for using STAC version 1.0.0!
150+
Please upgrade from version 1.0.0 to version 1.1.0!
136151

137152
Validator: stac-validator 3.5.0
138153

@@ -161,13 +176,12 @@ ASSET request errors:
161176
This object has 4 links
162177
</pre>
163178

179+
` stac-check sample_files/1.0.0/core-item-bad-links.json --links --assets`
164180

165-
166-
``` stac-check sample_files/1.0.0/core-item-bad-links.json --links --assets```
167181
<pre>
168182
<b>stac-check: STAC spec validation and linting tool</b>
169183

170-
Thanks for using STAC version 1.0.0!
184+
Please upgrade from version 1.0.0 to version 1.1.0!
171185

172186
Validator: stac-validator 3.5.0
173187

@@ -205,11 +219,12 @@ LINK request errors:
205219
This object has 4 links
206220
</pre>
207221

208-
``` stac-check sample_files/0.9.0/bad-item.json```
222+
` stac-check sample_files/0.9.0/bad-item.json`
223+
209224
<pre>
210225
<b>stac-check: STAC spec validation and linting tool</b>
211226

212-
Please upgrade from version 0.9.0 to version 1.0.0!
227+
Please upgrade from version 0.9.0 to version 1.1.0!
213228

214229
Validator: stac-validator 3.5.0
215230

@@ -229,11 +244,12 @@ Validation error message:
229244
This object has 5 links
230245
</pre>
231246

232-
``` stac-check https://stac-catalog.eu/collections/sentinel-s2-l2a/items/item1 --assets --no-assets-urls --header x-api-key $MY_API_KEY --header foo bar```
247+
` stac-check https://stac-catalog.eu/collections/sentinel-s2-l2a/items/item1 --assets --no-assets-urls --header x-api-key $MY_API_KEY --header foo bar`
248+
233249
<pre>
234250
<b>stac-check: STAC spec validation and linting tool</b>
235251

236-
Thanks for using STAC version 1.0.0!
252+
Please upgrade from version 1.0.0 to version 1.1.0!
237253

238254
Validator: stac-validator 3.5.0
239255

@@ -252,6 +268,9 @@ No ASSET format errors!
252268

253269
This object has 4 links
254270
</pre>
271+
255272
---
273+
256274
### Create local docs in the /docs folder
275+
257276
`$ pdoc --output-dir pdoc ./stac_check`

0 commit comments

Comments
 (0)