Installation
Install the Python package
Use pip to install the package:
pip install pyrumo
The package needs Python 3.9 or a later version. The package also installs Polars.
To use pandas DataFrames, install the pandas extra:
pip install "pyrumo[pandas]"
Install the command-line tool
Use a prebuilt binary
Each GitHub release has prebuilt binaries for these platforms:
| Operating system | Architecture |
|---|---|
| Linux | x86_64, aarch64 |
| Windows | x86_64 |
| macOS | x86_64, aarch64 |
To install a binary:
- Download the archive for your platform from the release page.
- Extract the archive.
- Move the
rumofile to a directory in yourPATH.
Build from the source code
The nemo rule engine needs the nightly Rust toolchain.
The file rust-toolchain.toml selects this toolchain automatically.
- Install Rust with rustup.
- Clone the repository.
- In the repository directory, run this command:
cargo install --path . --features rules
Note: If you do not set the
rulesfeature, therumo rulescommand is not available.
Cargo features
| Feature | Description |
|---|---|
rules | Adds the nemo rule engine. |
python | Adds the Python bindings. This feature also sets the rules feature. |