Skip to main content

Remove clutter from URLs and return a canonicalized version

Project description

cleanurl

Remove clutter from URLs and return a canonicalized version

Install

pip install cleanurl

or if you're using poetry:

poetry add cleanurl

Usage

By default cleanurl retuns a cleaned URL without respecting semantics. For example:

>>> import cleanurl
>>> r = cleanurl.cleanurl('https://www.xojoc.pw/blog/focus.html?utm_content=buffercf3b2&utm_medium=social&utm_source=snapchat.com&utm_campaign=buffe')
>>> r.url
'https://xojoc.pw/blog/focus'
>>> r.parsed_url
ParseResult(scheme='https', netloc='xojoc.pw', path='/blog/focus', params='', query='', fragment='')

The default parameters are useful if you want to get a canonical URL without caring if the resulting URL is still valid.

If you want to get a clean URL which is still valid call it like this:

>>> r = cleanurl.cleanurl('https://www.xojoc.pw/blog/////focus.html', respect_semantics=True)
>>> r.url
'https://www.xojoc.pw/blog/focus.html'

celeanurl.cleanurl parameters:

  • generic -> if True don't use site specific rules
  • respect_semantics -> if True make sure the returned URL is still valid, altough it may still contain some superfluous elements
  • host_remap -> whether to remap hosts. Example:
>>> import cleanurl
>>> cleanurl.cleanurl('https://threadreaderapp.com/thread/1453753924960219145', host_remap=True).url
'https://twitter.com/i/status/1453753924960219145'
>>> cleanurl.cleanurl('https://threadreaderapp.com/thread/1453753924960219145', host_remap=False).url
'https://threadreaderapp.com/thread/1453753924960219145'

For more examples see the unit tests.

Why?

While there are some libraries that handle general cases, this library has website specific rules that more aggresivly normalize urls.

Users

Initially used for discu.eu.

Discussions around the web

Who?

cleanurl was written by Alexandru Cojocaru.

License

cleanurl is Free Software and is released as AGPLv3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cleanurl-0.1.9.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

cleanurl-0.1.9-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file cleanurl-0.1.9.tar.gz.

File metadata

  • Download URL: cleanurl-0.1.9.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.2 Linux/5.10.0-13-amd64

File hashes

Hashes for cleanurl-0.1.9.tar.gz
Algorithm Hash digest
SHA256 7a587fa1ff757719ada4fc7ac796351006a11230238d123bbd41907fcd71b873
MD5 801076456343751bdaa5e3dfc84e0a78
BLAKE2b-256 6d75701dafbd3a4e2d02866ac21aa63f31770fa183be9e40f6371842427f1ba5

See more details on using hashes here.

File details

Details for the file cleanurl-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: cleanurl-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.2 Linux/5.10.0-13-amd64

File hashes

Hashes for cleanurl-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 9461422b387a43854e461e76fd2907b1c889d80ef145a3f1eb94ca97f21b45e0
MD5 09a7bce23e1d67d44232a9b4d2f9c8e3
BLAKE2b-256 141b03cf8872c3b7fa8227d57a5c4ddd9cf8b2d9549291b21119127768be8f12

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page