Skip to content

image2url/image2url-pypi

Repository files navigation

image2url (PyPI)

轻量级 Python SDK + CLI,用来把本地图片上传到 image2url API,返回一个可长期访问的公开 URL。默认指向 https://www.image2url.com/api/upload,也可通过环境变量切换到你自己的部署。

功能

  • 上传本地图片并返回永久 URL
  • 内置 2MB 体积校验(与默认 API 对齐,可自定义)
  • 自定义上传地址、超时时间与文件名
  • CLI 一键上传,或在 Python 代码中调用

安装

# 发布后
pip install image2url

# 本地开发/调试
pip install -e .[dev]

Python 快速开始

from image2url import Image2URLClient, upload_image

# 方式 1:直接用便捷函数
result = upload_image("avatar.png")
print(result.url)

# 方式 2:自定义客户端
client = Image2URLClient(
    endpoint="https://www.image2url.com/api/upload",
    timeout=15,
    max_size_mb=2,
)
result = client.upload_image("avatar.png", filename="profile.png")
print(result.url)

CLI 用法

# 最简单用法
image2url ./avatar.png

# 自定义地址、超时并输出完整 JSON
IMAGE2URL_ENDPOINT=https://your-domain.com/api/upload \
image2url ./avatar.png --timeout 30 --json

配置

  • IMAGE2URL_ENDPOINT:自定义上传地址(默认 https://www.image2url.com/api/upload
  • IMAGE2URL_TIMEOUT:请求超时秒数(默认 15)
  • max_size_mb:初始化客户端时自定义体积限制(默认 2MB)

本地开发

pip install -e .[dev]
python -m pytest

返回示例

{
  "success": true,
  "url": "https://www.image2url.com/images/1733090000-uuid.png",
  "filename": "images/1733090000-uuid.png",
  "originalName": "avatar.png",
  "size": 102400,
  "type": "image/png",
  "uploadedAt": "2024-12-02T00:00:00.000Z"
}

Releases

No releases published

Packages

 
 
 

Contributors

Languages