diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 32d46ee..0000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8ef2e0d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,31 @@ +# rustac + +> The power of Rust for the Python STAC ecosystem. + +**rustac** is a zero-dependency Python package for [STAC](https://stacspec.org/) using Rust under the hood. + +## Installation + +```shell +python -m pip install rustac +``` + +If you'd like to use `arrow` tables, e.g. to load into GeoPandas: + +```shell +python -m pip install 'rustac[arrow]' +``` + +## Usage + +```python +import asyncio +import rustac + +def main() -> None: + item = await rustac.read("item.json") + +asyncio.run(main()) +``` + +For more, see our [examples](./generated/gallery/index.md). diff --git a/mkdocs.yml b/mkdocs.yml index 8e7afdc..af6f257 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: rustac-py -site_description: A small no-dependency Python package for STAC, using Rust under the hood. +site_name: rustac +site_description: The power of Rust for the Python STAC ecosystem site_url: https://stac-utils.github.io/rustac-py repo_url: https://github.com/stac-utils/rustac-py theme: diff --git a/pyproject.toml b/pyproject.toml index f9bffbd..a1ae72b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "rustac" -description = "A no-dependency Python package for STAC, using Rust under the hood." +description = "The power of Rust for the Python STAC ecosystem" readme = "README.md" authors = [{ name = "Pete Gadomski", email = "pete.gadomski@gmail.com" }] requires-python = ">=3.10" @@ -76,6 +76,11 @@ docs = [ [tool.uv] default-groups = ["dev", "docs"] +cache-keys = [ + { file = "pyproject.toml" }, + { file = "Cargo.toml" }, + { file = "**/*.rs" }, +] [build-system] requires = ["maturin>=1.7,<2.0"]