Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/index.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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).
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
7 changes: 6 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]" }]
requires-python = ">=3.10"
Expand Down Expand Up @@ -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"]
Expand Down