shucker
| Crates.io | shucker |
| lib.rs | shucker |
| version | |
| source | src |
| created_at | 2024-12-31 14:04:40.919018+00 |
| updated_at | 2024-12-31 14:43:26.870073+00 |
| description | Tracking-param filtering library, designed to strip URLs down to their canonical forms |
| homepage | |
| repository | https://github.com/palfrey/shucker |
| max_upload_size | |
| id | 1500061 |
| Cargo.toml error: | TOML parse error at line 25, column 1 | 25 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Tom Parker-Shemilt (palfrey)
documentation
README
Shucker
Shucker is a tracking-param filtering library, designed to strip URLs down to their canonical forms. It contains internally a set of rules derived from the AdguardFilters TrackParamFilter set, and then stripped down be able to be runnable outside of a browser. Note that although the original filters were designed for Javascript-based browser extensions, Shucker's core is a pure-Rust implementation for raw speed (some testing done against Hyperfine, but certainly seems fast enough so far i.e. < 1ms).
There is an example command line tool provided (cargo run --bin shuck <list of urls>) but the main usage will either be via the shucker::shuck fn, or the Python shucker library with shucker.shuck (which is mostly a thin wrapper over the Rust code), both of which take a URL and return a version of it without the ad-tracking.
Rebuilding the rules set
make rebuild_rules will pull the latest upstream rules and rebuild.
Licensing
The actual core Shucker code (i.e. everything except the external/adguardfilters folder) is licensed under the LGPL v3. However, the external/adguardfilters code is GPL v3 and as that is used as part of the build-time generation of Shucker currently, the overall library is therefore GPLv3. This might change in the future if we remove said build-time requirement though.