Skip to main content

`URLicon` helps you to discover an possible icon from a URL.

Project description

URLicon - v0.2.1

URLicon helps you to discover an possible icon from a URL.

We check for the metatag icons, favicons and, if we don't find, we check the first image in the URL html code. Finally, if nothing is found, we use the https://ui-avatars.com/api/ to bring you at least some avatar-like icon.

How to install and use

Install with uv or pip

uv add urlicon
# or
pip urlicon

Usage:

from urlicon import urlicon

url = "https://this-is.your-url.com/some-path"

icon_url = urlicon.get_url_icon(url)

print("icon:", icon_url)
# icon: "https://this-is.your-url.com/icon.jpeg"

Caching

URLicon use the unforgettable "cache" to avoid unecessary URL requests. It uses a temp dir for each execution. But you can define a your own directory and use the cache as much as you want setting SIMPLE_CACHE_ROOT_DIR env var.

SIMPLE_CACHE_ROOT_DIR = os.getenv("SIMPLE_CACHE_ROOT_DIR", None)
cache = unforgettable(cache_folder=SIMPLE_CACHE_ROOT_DIR)

And you can clean the cache with:

urlicon.unforgettable.clean()

See Also

License

This package is distributed under the MIT license.

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

urlicon-0.2.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

urlicon-0.2.1-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file urlicon-0.2.1.tar.gz.

File metadata

  • Download URL: urlicon-0.2.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for urlicon-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1d420f2f8908b3e082e80c06ca7088e67e57b041c3b82c807fc84faea9ac0523
MD5 d855b893ff391d04d3fad69674fef5cc
BLAKE2b-256 f7ce01e688260c9768dab0f243bada5d6e8821051de5cdb254b6a522ebe4fa00

See more details on using hashes here.

File details

Details for the file urlicon-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: urlicon-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for urlicon-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1fc5888ae71ae25cfd620b53b9c418adef9167cd0034d039c9f23aef6ff953b1
MD5 89391411b313798243abe907488e28b8
BLAKE2b-256 f882dddb868e8b0c7ccc3a442c62cda8248f2c777d34748cf0c8f34a5860ca34

See more details on using hashes here.

Supported by

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