3 releases
| 0.0.5 | Apr 2, 2024 |
|---|---|
| 0.0.4 | Apr 2, 2024 |
| 0.0.4-alpha | Mar 10, 2024 |
#4 in #listing
299 downloads per month
145KB
4K
SLoC
lumni
lumni is a tool for interacting with object stores such as S3. It is built from the ground up in Rust, with APIs available for both Python and the web via JS/WASM.
The idea behind lumni is to create a high-performance and future-proof data tool that can scale with new (AI-driven) networking and usage patterns. This includes the ability to work in both client and service mode, and a modular design to allow compute functions on the network.
In the short term, the focus is on implementing basic features such as List, Copy, and Delete.
The current version (0.0.3) enables:
- listing and searching items on an S3 bucket or Local Filesystem.
- filtering by name, size, and modification time
- GET contents of an item from Local Filesystem or S3 bucket
Prerequisites
- Python or Rust
- Optional: S3 account with valid access key and secret key
# Development - maturin (cargo install --locked maturin) - trunk (cargo install trunk) - npx (brew install npm; npm install -g npx) - rustup target add wasm32-unknown-unknown
Installation
lumni can be used via Python (API) or directly via Rust (CLI). A (local-first) browser-based version is on the short-term roadmap.
Python (API)
Only Linux and MacOS wheels are pre-compiled. A Windows version should follow soon.
pip install lumni
Rust (CLI)
Clone the repository and compile the project using Cargo:
git clone https://github.com/serverlessnext/lumni.git
cd lumni
cargo build --release
Next, copy the binary from ./target/release/lumni to your local path.
Usage
Quickstart
List
# for s3://buckets: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY must be set export AWS_ACCESS_KEY_ID=your_access_key export AWS_SECRET_ACCESS_KEY=your_secret_key export AWS_REGION=us-east-1 # optional
# Find all files in the "reports" directory, with names containing "2023" and # modified within the last 30 days, in a given S3 bucket. lumni ls s3://bucket-name/reports/ --name "*2023*" --mtime "-30D # Find all files in the current directory, larger than 100 MB and modified # within the last 5 days. lumni ls . --size "+100M" --mtime "-5D" # Find all files larger than 1 megabyte (MB) in a given S3 Bucket lumni ls s3://bucket-name/ --size "+1M" --recursive # Find all files modified more than 1 hour ago, recursively lumni ls . --mtime "+1h" --recursive
More List examples here.
Request
# print file contents from local file to stdout lakestream -X GET README.rst # write file contents from S3 to local file lakestream -X GET s3://bucket-name/100MB.bin > 100MB.bin
More Request examples here.
Python can also be used as a CLI. Arguments are mapped 1:1 to the Rust library.
# Python python -m lumni ls ./ # Rust lumni ls ./
Python API
import lumni client = lumni.Client() # Define a filter dictionary filter_dict = { "name": "example.txt", "size": "5", "mtime": "1D", } # List the contents of a storage location with the filter result = client.list("s3://your-bucket", recursive=True, filter_dict=filter_dict) print(result)
Python API Documentation here.
Contributing
Contributions to the lumni project are welcome. Please open an issue or submit a pull request on the GitHub repository.
License
lumni is released under the Apache-2.0 license. See LICENSE for more details.
Links
Documentation: https://lumnidata.com
Dependencies
~8–25MB
~395K SLoC