bumpies

Author: TheTechromancer

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "radixtarget"
-version = "4.0.3"
+version = "4.0.4"
 edition = "2024"
 description = "Fast radix tree implementation for IP addresses and hostnames with target matching"
 license = "GPL-3.0"
@@ -16,7 +16,7 @@ crate-type = ["rlib", "cdylib"]
 [dependencies]
 idna = "1.0.3"
 ipnet = "2.10"
-pyo3 = { version = "0.26", features = ["extension-module"] }
+pyo3 = { version = "0.27", features = ["extension-module"] }
 seahash = "4.1"
 
 [dev-dependencies]

Cargo.toml

@@ -59,8 +59,26 @@ rt.get("example.com") # None
 # Custom data nodes
 rt.add("evilcorp.co.uk", "custom_data")
 rt.get("www.evilcorp.co.uk") # "custom_data"
+
+# Insertion returns unique identifier
+insertion_id = rt.insert("10.0.0.1/8")
+assert insertion_id == "10.0.0.0/8"
+
+# Store custom data with any entry
+rt.insert("example.org", data={"tags": ["production"], "priority": 1})
+result = rt.get("api.example.org")
+# result contains your custom data: {"tags": ["production"], "priority": 1}
 ```
 
+## API Differences: Python vs Rust
+
+Both APIs provide an `insert()` method that returns a unique string identifier for each entry (a normalized version of the hostname or IP address). However, the Python API includes additional functionality:
+
+- **Rust**: `insert()` returns a string that uniquely identifies the insertion
+- **Python**: `insert()` also returns this unique identifier string, but additionally supports a `data=` parameter that allows you to store custom data of any Python type alongside the entry. When you later call `get()`, it returns your custom data instead of just the matched target string.
+
+This makes the Python API more flexible for applications that need to associate metadata with targets, while the Rust API focuses on pure performance for lookups.
+
 ## Rust
 
 ### Installation

README.md

@@ -1,6 +1,6 @@
 [project]
 name = "radixtarget"
-version = "4.0.3"
+version = "4.0.4"
 description = "Fast radix tree for IP addresses and DNS names"
 authors = [{name = "TheTechromancer"}]
 license = {text = "GPL-3.0"}