stac-utils / stac-utils/pystac
Deprecation plan for STAC versions <1.0
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 463
- Forks
- 134
- Avg merge
- 10h
- Merged PRs (30d)
- 4
Description
It seems like it would simplify the code base significantly and make long-term maintenance more manageable if we were able to remove support for pre-1.0 STAC spec versions. However, we want to do this in a way that is transparent for users and allows them to plan for updates to libraries that have PySTAC as a dependency. Since removing support for these pre-1.0 versions represents a breaking change, we will also need to consider how it affects versioning of this library. Do we want to remove support for these versions prior to a PySTAC 1.0 release, or should we release 1.0 with deprecation notices for these versions and remove them in a 2.0 release? In either case, we should have a public plan for handling these deprecations in place by the PySTAC 1.0 release.
The purpose of this issue is to discuss a plan for deprecating and subsequently removing support for these pre-1.0 STAC spec versions.
cc: @lossyrob @gadomski @matthewhanson @jbants
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue body and its nine-comment discussion about removing pre-1.0 STAC support. Define a public deprecation plan covering whether removal happens before PySTAC 1.0 or in 2.0, and how the breaking change affects versioning. Done means the plan is agreed and documented for users and dependent libraries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- release
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100