stac-rs

Rust implementation of the SpatioTemporal Asset Catalog (STAC) specification. Not yet published to crates.io.

Quickstart

Read STAC objects:

let object = stac::read("data/catalog.json").unwrap();
println!("{}", object.id());

Read STAC catalogs as trees:

use stac::Stac;
let (stac, _) = Stac::read("data/catalog.json").unwrap();

Write STAC catalogs using the BestPracticesRenderer:

use stac::{BestPracticesRenderer, Render, Writer, Write};
let renderer = BestPracticesRenderer::new("a/new/root/directory").unwrap();
let writer = Writer::default();
stac.write(&renderer, &writer).unwrap();

For a more complete walkthrough, see the documentation.

Examples

There is a brief example at examples/copy.rs that demonstrates a simple read-write operation. You can use it from the command line:

cargo run --examples copy data/catalog.json tmp

Development

See CONTRIBUTING.md for information about contributing to this project.

Releasing

To create a new release:

Create a new branch that starts with release/, e.g. release/v0.1.0
Update the version in Cargo.toml
Update CHANGELOG.md
Open a pull request
If the pull request succeeds (it should run a special cargo publish --dry-run action to check publish-ability), merge
Create an annotated tag pointing to the release, including the information from the changelog section corresponding to your release
Push your tag to Github
Publish your crate

License