Metadata-Version: 2.1
Name: Unalix-Rev
Version: 0.9.1
Summary: Small, dependency-free, fast Python package for removing tracking fields from URLs.
Author-Email: SnwMds <snwmds@tutanota.com>
Maintainer-Email: icealtria <icealtria@gmail.com>
License: LGPL-3.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: Android
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet
Classifier: Topic :: Security
Project-URL: Homepage, https://github.com/icealtria/Unalix-Rev
Project-URL: Bug tracker, https://github.com/icealtria/Unalix-Rev/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Unalix

Unalix is a library written in Python, it implements the specification used by the [ClearURLs](https://github.com/ClearURLs/Addon) addon for removing tracking fields from URLs.

## Installation

Install using `pip`:

```bash
pip install Unalix-Rev
```

_**Note**: Unalix requires Python 3.7 or higher._

## Usage:

Removing tracking fields:

```python
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:

```python
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:

- **ClearURLs**
  - Author: Kevin Röbert
  - Repository: [ClearURLs/Rules](https://github.com/ClearURLs/Rules)
  - License: [GNU Lesser General Public License v3.0](https://gitlab.com/ClearURLs/Rules/blob/master/LICENSE)

- **Requests**
  - Author: Kenneth Reitz
  - Repository: [psf/requests](https://github.com/psf/requests)
  - License: [Apache v2.0](https://github.com/psf/requests/blob/master/LICENSE)

- **Pyrogram**
  - Author: Dan
  - Repository: [pyrogram/pyrogram](https://github.com/pyrogram/pyrogram)
  - License: [LGPL-3.0](https://github.com/pyrogram/pyrogram/blob/master/COPYING)
