BlurHash Python 项目教程

BlurHash Python 项目教程

blurhash-pythonPython version of the BlurHash encoder项目地址:https://gitcode.com/gh_mirrors/bl/blurhash-python

1. 项目的目录结构及介绍

BlurHash Python 项目的目录结构如下：

blurhash-python/
├── blurhash/
│   ├── __init__.py
│   ├── blurhash.py
│   └── tests/
│       ├── __init__.py
│       └── test_blurhash.py
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── blurhash_example.png
├── cool_cat_small.jpg
├── example.py
├── setup.cfg
└── setup.py

目录介绍

• blurhash/: 包含 BlurHash 算法的主要实现文件。
  • __init__.py: 初始化文件，使得 blurhash 成为一个 Python 包。
  • blurhash.py: BlurHash 算法的核心实现。
  • tests/: 包含测试文件。
    • __init__.py: 初始化文件，使得 tests 成为一个 Python 包。
    • test_blurhash.py: 针对 blurhash.py 的测试文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 用于打包的清单文件。
• README.md: 项目说明文档。
• blurhash_example.png: 示例图片。
• cool_cat_small.jpg: 示例图片。
• example.py: 示例代码文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本文件。

2. 项目的启动文件介绍

项目的启动文件是 example.py，它展示了如何使用 BlurHash 算法对图片进行编码。

example.py 内容

import blurhash
from PIL import Image
import numpy as np

# 打开图片文件
image = Image.open("cool_cat_small.jpg")

# 将图片转换为 NumPy 数组
image_array = np.array(image.convert("RGB"))

# 生成 BlurHash
hash = blurhash.encode(image_array, x_components=4, y_components=3)

print(f"BlurHash: {hash}")

启动步骤

1. 确保已经安装了 blurhash 和 Pillow 库。
2. 运行 example.py 文件：

python example.py

3. 项目的配置文件介绍

项目的配置文件主要是 setup.cfg 和 setup.py。

setup.cfg

setup.cfg 文件包含了项目的安装配置信息，例如包的元数据、依赖项等。

setup.py

setup.py 文件是 Python 项目的标准安装脚本，用于定义项目的安装过程。

配置文件内容

setup.cfg

[metadata]
name = blurhash-python
version = 1.2.2
description = BlurHash encoder implementation for Python
long_description = file: README.md
long_description_content_type = text/markdown
author = Atte Lautanala
author_email = atte.lautanala@example.com
url = https://github.com/halcy/blurhash-python
license = MIT
classifiers =
    Development Status :: 5 - Production/Stable
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Programming Language :: Python :: 3.12

[options]
packages = find:
python_requires = >=3.8
install_requires =
    Pillow
    numpy

[options.packages.find]
where = .

setup.py

from setuptools import setup, find_packages

setup(
    name="blurhash-python",
    version="1.2.2",
    description="BlurHash encoder implementation for Python",
    long_description=open("README.md").read

blurhash-pythonPython version of the BlurHash encoder项目地址:https://gitcode.com/gh_mirrors/bl/blurhash-python