Metadata-Version: 2.1
Name: Unalix
Version: 0.2
Summary: A simple module that removes tracking fields from URLs.
Home-page: https://github.com/SnwMds/Unalix
Author: Amano Team
Author-email: contact@amanoteam.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests

### What it does?

In addition to removing tracking fields from URLs, Unalix also try to gets the direct link from shortened URLs.

Unalix also transform YouTube, Twitter and Instagram links into Invidious, Nitter and Bibliogram links.

### Installation

```
pip install --upgrade 'unalix'
```
or
```
pip install --upgrade 'git+https://github.com/SnwMds/Unalix'
```

### Usage:

Let's see some examples:

```python
>>> from unalix import clear_url
>>> 
>>> clear_url('http://example.com/index.html?utm_source=amp&__twitter_impression=true') # URL with some tracking parameters from Google Analytics and Twitter
'http://example.com/index.html'
>>> 
>>> clear_url('http://goo.gl/ko4LWp') # A shortened URL
'https://forum.xda-developers.com/android/apps-games/app-youtube-vanced-edition-t3758757'
>>> 
>>> clear_url('https://youtu.be/o5DnSWi06b8') # YouTube video link
'https://invidio.us/watch?v=o5DnSWi06b8'
>>> 
>>> clear_url('https://twitter.com/funimation') # Twitter profile link
'https://nitter.net/funimation'
>>> 
>>> clear_url('https://www.instagram.com/p/B89TWTdlEXf/') # Instagram post link
'https://bibliogram.pussthecat.org/p/B89TWTdlEXf/'
>>>
```

### Limitations

Unalix has some limitations related to link processing, see them below:

#### Getting direct links from URL shorteners

Unalix only follows the URLs/paths provided by the `Location` header (see [RFC 7231, section 7.1.2: Location](https://tools.ietf.org/html/rfc7231#section-7.1.2)). It means that Unalix cannot obtain direct links from URL shorteners that require user interaction (e.g clicking a button or resolving CAPTCHA) to redirect or that uses JavaScript code to redirect.

### Contact

Want to say something? Need some help? [Open a issue](https://github.com/SnwMds/Unalix/issues) or [send a email](http://scr.im/SnwMds).

### License

Unalix in licensed under the [GNU Lesser General Public License v3.0](https://github.com/AmanoTeam/Unalix/blob/master/LICENSE).

### Third party software

Unalix includes some third party software. See them below:

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


