Skip to content

Commit 03381d8

Browse files
authored
docs: some light readme work (#94)
1 parent f40236c commit 03381d8

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A: **rustac** can
2323

2424
If you don't need those things, **rustac** probably isn't for you — use **pystac** and its friend, [pystac-client](https://github.com/stac-utils/pystac-client).
2525

26-
## Usage
26+
## Installation
2727

2828
Install via **pip**:
2929

@@ -41,7 +41,22 @@ Or via **conda**:
4141
conda install conda-forge::rustac
4242
```
4343

44-
Then:
44+
### From source
45+
46+
By default, **rustac** wants to find DuckDB on your system:
47+
48+
```shell
49+
brew install duckdb # if you're using Homebrew ... if not, get DuckDB another way
50+
python -m pip install -U git+https://github.com/stac-utils/rustac-py
51+
```
52+
53+
If you don't want to (or can't) install DuckDB, _can_ build DuckDB as a "bundled" build (warning: it takes a while):
54+
55+
```shell
56+
MATURIN_PEP517_ARGS="--features=duckdb-bundled" python -m pip install -U git+https://github.com/stac-utils/rustac-py
57+
```
58+
59+
## Usage
4560

4661
```python exec="on" source="above"
4762
import asyncio
@@ -87,17 +102,14 @@ asyncio.run(main())
87102
See [the documentation](https://stac-utils.github.io/rustac-py) for details.
88103
In particular, our [examples](https://stac-utils.github.io/rustac-py/latest/generated/gallery/) demonstrate some of the more interesting features.
89104

90-
## CLI
105+
## Command line interface (CLI)
91106

92107
**rustac** comes with a CLI:
93108

94109
```bash exec="on" source="above" result="text"
95110
rustac -h
96111
```
97112

98-
> [!NOTE]
99-
> Before **rustac** v0.5.4, the CLI was its own PyPI package named **stacrs-cli**, which is no longer needed.
100-
101113
## stac-geoparquet
102114

103115
**rustac** replicates much of the behavior in the [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet) library, and even uses some of the same Rust dependencies.

0 commit comments

Comments
 (0)