apunkt/flakestorm
1
0
Fork 0
mirror of https://github.com/flakestorm/flakestorm.git synced 2026-04-25 00:36:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update version to 0.8.0 in pyproject.toml, enhance README.md and USAGE_GUIDE.md with optional Rust extension installation instructions for improved performance, and remove outdated keywords_extractor_agent documentation.

Browse source
This commit is contained in:
Francisco M Humarang Jr. 2026-01-02 22:32:18 +08:00
parent 408c4fed46
commit e673b21b55
3 changed files with 38 additions and 494 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/USAGE_GUIDE.md
View file

@ -377,13 +377,16 @@ pip install --upgrade pip
pip --version
# 9. Now install flakestorm
# From PyPI (when published)
# From PyPI (recommended)
pip install flakestorm
# 10. (Optional) Install Rust extension for 80x+ performance boost
pip install flakestorm_rust
# From source (development)
git clone https://github.com/flakestorm/flakestorm.git
cd flakestorm
pip install -e ".[dev]"
# git clone https://github.com/flakestorm/flakestorm.git
# cd flakestorm
# pip install -e ".[dev]"
```
**Note:** Ollama is installed at the system level and doesn't need to be in your virtual environment. The virtual environment is only for Python packages (flakestorm and its dependencies).
@ -408,7 +411,27 @@ python3 --version # Should be 3.10 or higher
### Step 4: (Optional) Install Rust Extension
For 80x+ performance improvement on scoring:
For 80x+ performance improvement on scoring, install the Rust extension. You have two options:
#### Option 1: Install from PyPI (Recommended - Easiest)
```bash
# 1. Make sure virtual environment is activated
source venv/bin/activate # If not already activated
which pip # Should show: .../venv/bin/pip
# 2. Install from PyPI (automatically downloads the correct wheel for your platform)
pip install flakestorm_rust
# 3. Verify installation
python -c "import flakestorm_rust; print('Rust extension installed successfully!')"
```
**That's it!** The Rust extension is now installed and flakestorm will automatically use it for faster performance.
#### Option 2: Build from Source (For Development)
If you want to build the Rust extension from source (for development or if PyPI doesn't have a wheel for your platform):
```bash
# 1. CRITICAL: Make sure virtual environment is activated
@ -445,6 +468,8 @@ ls ../target/wheels/flakestorm_rust-*.whl
python -c "import flakestorm_rust; print('Rust extension installed successfully!')"
```
**Note:** The Rust extension is completely optional. flakestorm works perfectly fine without it, just slower. The extension provides significant performance improvements for scoring operations.
### Verify Installation
```bash