Installation¶

Grafeo can be used from both Python and Rust. Choose the installation method for your preferred language.

Python¶

Using uv (Recommended)¶

uv is a fast Python package installer:

uv add grafeo

Using pip (alternative)¶

pip install grafeo  # If uv is not available

Verify Installation¶

import grafeo

# Print version
print(grafeo.__version__)

# Create a test database
db = grafeo.Database()
print("Grafeo installed successfully!")

Platform Support¶

Rust¶

Using Cargo¶

Add Grafeo to your project:

cargo add grafeo

Or add it manually to your Cargo.toml:

[dependencies]
grafeo = "0.1"

Feature Flags¶

Grafeo supports optional features:

[dependencies]
grafeo = { version = "0.1", features = ["full"] }

Verify Installation¶

use grafeo::Database;

fn main() -> Result<(), grafeo::Error> {
    let db = Database::open_in_memory()?;
    println!("Grafeo installed successfully!");
    Ok(())
}

Building from Source¶

Clone the Repository¶

git clone https://github.com/StevenBtw/grafeo.git
cd grafeo

Build Rust Crates¶

cargo build --workspace --release

Build Python Package¶

cd crates/grafeo-python
uv add maturin
maturin develop --release

Next Steps¶

Now that you have Grafeo installed, continue to the Quick Start guide.