Skip to content

Commit

Permalink
Add python build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PikminGuts92 committed Jan 18, 2024
1 parent 39b2808 commit 5c6096a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Setup Python Environment
```bash
python -m venv .env
. .env/Scripts/activate # Using Git Bash on Windows
pip install maturin
```

## Run (Development)
```bash
# Adds grim api as python module to current env
maturin develop -m ./core/grim/Cargo.toml --all-features
```

## Build and Install
```bash
# Build grim api as python module in target/wheels
maturin build -m ./core/grim/Cargo.toml --all-features -r

# Use '--force-reinstall' to override pre-existing install
# Note: File name may be different depending on build target
pip install ./target/wheels/grim-0.1.0-cp310-none-win_amd64.whl --force-reinstall
```

0 comments on commit 5c6096a

Please sign in to comment.