Metadata-Version: 2.1
Name: url_cleaner
Version: 0.1.5
Summary: A package for removing tracing parameters from URLs. This package supports automatically updating filtering rules from Adguard
Project-URL: Homepage, https://github.com/fireindark707/url_cleaner
Project-URL: Bug Tracker, https://github.com/fireindark707/url_cleaner/issues
Author-email: phoenix000 <phoenix000.taipei@gmail.com>
License-File: LICENCE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# URL Cleaner

[![PyPI version](https://badge.fury.io/py/url-cleaner.svg)](https://badge.fury.io/py/url-cleaner)

## Introduction

A package for removing tracing parameters from URLs. This package supports:
- *Automatically updating* filtering rules from Adguard.
- Custom filtering rules.
- *Host pathname specific* filtering.
- *Hundreds of filtering rules* for using!

Inspired by [ClearUrl](https://github.com/ttttmr/ClearUrl) and [URL Bot](https://github.com/yingziwu/url_bot), thanks for their efforts!

Rules from:
1. [AdguardFilters]("https://github.com/AdguardTeam/AdguardFilters/raw/master/TrackParamFilter/sections/")
2. [url_bot]("https://github.com/yingziwu/url_bot/blob/master/src/rules-trackparm.ts")

## Examples

原始： https://baijiahao.baidu.com/s?id=1748839822649920321&wfr=spider&for=pc  
清除后： https://baijiahao.baidu.com/s?id=1748839822649920321

原始： https://mp.weixin.qq.com/s?__biz=MjM5OTExMjYwMA==&mid=2670081058&idx=6&sn=1ad7112020c2a4104d67ca542ab14444&chksm=bc12eed58b6567c30c78123a9e8901241512642305dabae4fa1f52357f5ce0ac7a85554#rd  
清除后： https://mp.weixin.qq.com/s?__biz=MjM5OTExMjYwMA%3D%3D&mid=2670081058&idx=6&sn=1ad7112020c2a4104d67ca542ab14444#rd

原始： https://www.bilibili.com/video/BV158411b7ki/?spm_id_from=333234107.tianma.1-2-2.click  
清除后： https://www.bilibili.com/video/BV158411b7ki/

## Usage

### Install

```
pip install url-cleaner
```

### Clean URLs

```python3
from url_cleaner import UrlCleaner
c = UrlCleaner()
url = "https://baijiahao.baidu.com/s?id=1748839822649920321&wfr=spider&for=pc"
cleaned = c.clean(url)
print(cleaned)
```

https://baijiahao.baidu.com/s?id=1748839822649920321

### Update rules

```python3
from url_cleaner import UrlCleaner
c = UrlCleaner()
c.ruler.update_rules()
```
