diff --git a/README.md b/README.md index 6ebccd8..009bb8d 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,11 @@ **Fast graph queries on Lance** -[![Rust tests](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/rust-test.yml/badge.svg?branch=main)](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/rust-test.yml) -[![Python tests](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/python-test.yml/badge.svg?branch=main)](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/python-test.yml) -[![PyPI version](https://img.shields.io/pypi/v/lance-csr?color=555)](https://pypi.org/project/lance-csr/) -[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-555)](LICENSE) +[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue?style=for-the-badge)](LICENSE) +[![Rust tests](https://img.shields.io/github/actions/workflow/status/hyperdimensionalcomputingai/lance-csr/rust-test.yml?branch=main&label=rust%20tests&logo=rust&style=for-the-badge)](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/rust-test.yml) +[![Python tests](https://img.shields.io/github/actions/workflow/status/hyperdimensionalcomputingai/lance-csr/python-test.yml?branch=main&label=python%20tests&logo=python&logoColor=white&style=for-the-badge)](https://github.com/hyperdimensionalcomputingai/lance-csr/actions/workflows/python-test.yml) +[![crates.io](https://img.shields.io/crates/v/lance-csr?logo=rust&style=for-the-badge)](https://crates.io/crates/lance-csr) +[![PyPI](https://img.shields.io/pypi/v/lance-csr?logo=pypi&logoColor=white&style=for-the-badge)](https://pypi.org/project/lance-csr/) [Documentation](https://lance-csr.hdclabs.ai/) · [Examples](examples/README.md) · [Releases](https://github.com/hyperdimensionalcomputingai/lance-csr/releases) · [Contributing](CONTRIBUTING.md) @@ -58,9 +59,9 @@ case needs distributed graph queries or graph algorithms, that's the kind of eng uv add lance-csr ``` -Prebuilt wheels cover Linux x86-64, native Apple Silicon and Windows x86-64 (CPython 3.12+); no Rust toolchain is needed. From -Rust, run `cargo add lance-csr` and see the [Rust guide](https://lance-csr.hdclabs.ai/rust/). To build from -source, see [`python/DEVELOPMENT.md`](python/DEVELOPMENT.md). +Prebuilt wheels cover Linux x86-64, native Apple Silicon and Windows x86-64 (CPython 3.12+); no Rust toolchain is needed. On +Windows you can also use lance-csr inside WSL2, where it installs the Linux wheel. From Rust, run +`cargo add lance-csr` and see the [Rust guide](https://lance-csr.hdclabs.ai/rust/). To build from source, see [`python/DEVELOPMENT.md`](python/DEVELOPMENT.md). ## Example diff --git a/docs/getting-started.md b/docs/getting-started.md index 3234d79..46923bb 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -25,8 +25,9 @@ lance-csr is published on PyPI as `lance-csr`. Use [uv](https://docs.astral.sh/u uv add lance-csr --no-build-package lance-csr ``` -Prebuilt wheels cover **Linux x86-64** (glibc 2.28+: RHEL 8, Ubuntu 20.04 and later) and **Apple Silicon** -(macOS 11+), for **CPython 3.12, 3.13 and 3.14**. Installing a wheel needs no Rust toolchain. Other platforms +Prebuilt wheels cover **Linux x86-64** (glibc 2.28+: RHEL 8, Ubuntu 20.04 and later), **Apple Silicon** +(macOS 11+) and **Windows x86-64**, for **CPython 3.12, 3.13 and 3.14**. Installing a wheel needs no Rust +toolchain. On Windows you can also use lance-csr inside WSL2, where it installs the Linux wheel. Other platforms build from the source distribution, which needs Rust and `protoc` (see [Contributing](contributing.md)). The package depends on `pyarrow>=14` and `pylance` 13.x, which uv installs for you. diff --git a/python/README.md b/python/README.md index aab38d3..9beab6f 100644 --- a/python/README.md +++ b/python/README.md @@ -27,7 +27,8 @@ no Rust toolchain; to make sure uv never falls back to compiling from source, us uv add lance-csr --no-build-package lance-csr ``` -Other platforms install from the source distribution, which needs Rust and `protoc`. +On Windows you can also use lance-csr inside WSL2, where it installs the Linux x86-64 wheel. Other +platforms install from the source distribution, which needs Rust and `protoc`. ## Quick Start @@ -206,7 +207,7 @@ r2 = engine.execute( ## Requirements -- Python 3.12 or newer (3.12, 3.13 and 3.14 tested); macOS arm64 or Linux x86-64 +- Python 3.12 or newer (3.12, 3.13 and 3.14 tested); macOS arm64, Linux x86-64 or Windows x86-64 (natively or in WSL2) - `pylance` 13.x for writing Lance datasets ## Contributing