Skip to content

Commit b9abe9e

Browse files
committed
feat: add docs warning
1 parent 5bb1503 commit b9abe9e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
# PySTAC
22

3+
!!! warning
4+
5+
These docs are for the work-in-progress v2 of PySTAC.
6+
For the current PySTAC v1 docs, see <https://pystac.readthedocs.io>.
7+
8+
Our work plan for v2 goes like this:
9+
10+
1. Rebuild the core data structures (`Item`, `Catalog`, `Collection`, etc) from scratch, with new tests
11+
2. Slowly re-add the old tests to the `tests/v1` one at a time, to make sure that we're breaking as little as possible
12+
3. If we intentionally break a test (e.g. by relaxing a check on inputs) we'll mark it `xfail` and copy it to test the new expected behavior
13+
14+
This will take a while.
15+
Watch <https://github.com/stac-utils/pystac/tree/v2> to track our progress.
16+
We'll sometimes use pull requests, but sometimes not.
17+
318
**PySTAC** is a Python library for reading and writing [SpatioTemporal Asset Catalog (STAC)](https://stacspec.org) metadata.
419
To install:
520

21+
<!-- markdownlint-disable MD046 -->
622
```shell
723
python -m pip install pystac
824
```

0 commit comments

Comments
 (0)