ThumbHash for Python
Introduction
The thumbhash library implements the Thumbhash image placeholder generation algorithm invented by Evan Wallace in Python.
A full explanation and interactive example of the algorithm can be found at https://github.com/evanw/thumbhash
Installation
You need Python 3.7+.
$ pip install thumbhash-python
Usage
Create thumbhash from image file:
from thumbhash import image_to_thumbhash
with open('image.jpg', 'rb') as image_file:
hash = image_to_thumbhash(image_file)
You can also pass file name as parameter to the function:
from thumbhash import image_to_thumbhash
hash = image_to_thumbhash('image.jpg')
These functions use the Pillow library to read the image.
If you want to directly convert a rgba array to a thumbhash, you can use the low-level function:
from thumbhash.encode import rgba_to_thumbhash
rgba_to_thumbhash(w: int, h: int, rgba: Sequence[int]) -> bytes
To decode a thumbhash into an image:
from thumbhash import thumbhash_to_image
image = thumbhash_to_image("[THUMBHASH]", base_size=128)
image.show()
image.save('path/to/file.png')
Alternatively you can use the following function to deal directly with the pixels array (without relying on Pillow):
from thumbhash.decode import thumbhash_to_rgba
def thumbhash_to_rgba(
hash: bytes, base_size: int = 32, saturation_boost: float = 1.25
) -> Tuple[int, int, List[int]]
CLI
You can also use the CLI mode to encode or decode directly via your shell.
Usage:
$ thumbhash [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
decode: Save thumbnail image from thumbhashencode: Get thumbhash from image
thumbhash decode
Save thumbnail image from thumbhash
Usage:
$ thumbhash decode [OPTIONS] IMAGE_PATH HASH
Arguments:
IMAGE_PATH: The path where the image created from the hash will be saved [required]HASH: The base64-encoded thumbhash [required]
Options:
-s, --size INTEGER RANGE: The base size of the output image [default: 32; x>=1]--saturation FLOAT: The saturation boost factor to use [default: 1.25]--help: Show this message and exit.
thumbhash encode
Get thumbhash from image
Usage:
$ thumbhash encode [OPTIONS] IMAGE_PATH
Arguments:
IMAGE_PATH: The path of the image to convert [required]
Options:
--help: Show this message and exit.
Contributing
See Contributing documentation
License
thumbhash-python is distributed under the terms of the MIT license.
Metadata
Release files for thumbhash-python 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| thumbhash_python-1.0.1.tar.gz | 54.4 kB | Without provenance | Details for thumbhash_python-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| thumbhash_python-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for thumbhash_python-1.0.1-py3-none-any.whl |
Total release size: 64.1 kB
Release files / thumbhash_python-1.0.1.tar.gz
| Download URL | thumbhash_python-1.0.1.tar.gz |
|---|---|
| Size | 54.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9212871c5ddf10487148c767ebd8785c8010f79e378709805bc8729d4293e03d
|
|
BLAKE2b-256 checksum How to use checksums |
6f29bcb4a01ce7faab0888b00f2eb73e1a6a18b241549ebda61e8e5b31424a37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.23.3
|
Release files / thumbhash_python-1.0.1-py3-none-any.whl
| Download URL | thumbhash_python-1.0.1-py3-none-any.whl |
|---|---|
| Size | 9.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b1bc4ac08ff4354dba70a0caf85a9b3f3522181fbd3e05eb4f03aa786a36578b
|
|
BLAKE2b-256 checksum How to use checksums |
3d0eb77ae42436765e3e6323a02df99d6999b82edea7123530448979bbe97045
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.23.3
|
Security for thumbhash-python 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.