philiprehberger-url-clean 0.3.0

Remove tracking parameters from URLs

philiprehberger-url-clean

Remove tracking parameters from URLs.

Installation

pip install philiprehberger-url-clean

Usage

from philiprehberger_url_clean import clean, remove_params, normalize

# Remove tracking params (utm_*, fbclid, gclid, etc.)
clean("https://example.com/page?utm_source=twitter&id=123")
# "https://example.com/page?id=123"

# Remove specific params
remove_params("https://example.com?a=1&b=2&c=3", ["b", "c"])
# "https://example.com?a=1"

# Normalize URL
normalize("HTTPS://Example.COM/path/../page?b=2&a=1")
# "https://example.com/page?a=1&b=2"

# Batch processing
clean_many(["https://example.com?utm_source=x", ...])

# Get the list of stripped params alongside the cleaned URL
from philiprehberger_url_clean import clean_url, register_tracking_param

cleaned, removed = clean_url("https://example.com?utm_source=x&id=1")
# cleaned = "https://example.com?id=1"
# removed = ["utm_source"]

# Add a custom tracking param at runtime
register_tracking_param("internal_ref")
clean("https://example.com?internal_ref=abc&id=1")
# "https://example.com?id=1"

Extracting the domain

from philiprehberger_url_clean import domain

domain("https://Example.com/foo?utm=x")
# "example.com"

domain("https://example.com:8080/")
# "example.com"

domain("example.com/path")
# "example.com"

Checking if a URL is clean

from philiprehberger_url_clean import is_clean

is_clean("https://example.com/?id=42")
# True

is_clean("https://example.com/?utm_source=newsletter")
# False

API

Function / Class	Description
clean(url, extra_params=None)	Remove known tracking parameters
clean_url(url, extra_params=None)	Returns (cleaned_url, removed_params) tuple
remove_params(url, params)	Remove specific parameters
normalize(url)	Lowercase host, sort params, resolve path
clean_many(urls, extra_params=None)	Batch clean
domain(url)	Return the lowercased hostname from a URL
is_clean(url)	Return True when no tracking params are present
register_tracking_param(name)	Add a parameter to the global tracking set
unregister_tracking_param(name)	Remove a parameter from the global tracking set

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT