Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (50 loc) · 2.05 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.05 KB
Raw

Unalix

Unalix is a library written in Python, it implements the specification used by the ClearURLs addon for removing tracking fields from URLs.

Installation

Install using pip:

python3 -m pip install --force-reinstall \
    --disable-pip-version-check \
    --upgrade \
    'unalix'

The version from git might be broken sometimes, but you can also install from it:

python3 -m pip install --force-reinstall \
    --disable-pip-version-check \
    --upgrade \
    'https://codeload.github.com/AmanoTeam/Unalix/tar.gz/refs/heads/master'

Note: Unalix requires Python 3.6 or higher.

Usage:

Removing tracking fields:

import unalix

url: str = "https://deezer.com/track/891177062?utm_source=deezer"
result: str = unalix.clear_url(url=url)

assert result == "https://deezer.com/track/891177062"

Resolving shortened URL:

import unalix

url: str = "https://bitly.is/Pricing-Pop-Up"
result: str = unalix.unshort_url(url=url)

assert result == "https://bitly.com/pages/pricing"

Tip: The unshort_url() method will strip tracking fields from any URL before following a redirect, so you don't need to manually call clear_url() for it's return value.

Contributing

If you have discovered a bug in this library and know how to fix it, fork this repository and open a Pull Request.

Third party software

Unalix includes some third party software in its codebase. See them below: