Skip to main content

CLI tool for image processing and uploading to cloud storage.

Project description

PicFlow

License: MIT Python Version

English | 中文

PicFlow is a command-line tool for automating image processing (scaling/compression) and uploading to cloud storage (e.g., Qiniu Cloud). Supports Windows, Linux, and macOS.

Features

🛠️ Core Capabilities

  • Image Processing
    • Scaling, format conversion (JPEG/PNG/WebP)
    • Quality compression (based on cwebp and ImageMagick)
  • Cloud Storage Integration
    • Supports Qiniu Cloud, AWS S3 (planned)
    • Auto-generates CDN URLs
  • Batch Operations
    • Recursively process folders
    • Parallel task acceleration

🚀 Efficiency

  • Config-Driven: Manage cloud keys and parameters via YAML
  • Cross-Platform: Run the same command on Windows/Linux/macOS

Installation

Prerequisites

  • Python 3.8+
  • External Tools (auto-detected):

Install PicFlow

pip install picflow

Quick Start

1. Configure Qiniu

Create config file ~/.picflow/config.yaml

storage:
  qiniu:
    access_key: "YOUR_ACCESS_KEY"
    secret_key: "YOUR_SECRET_KEY"
    bucket: "YOUR_BUCKET_NAME"
    domain: "https://cdn.example.com"  # CDN domain

2. Process & Upload Images

# Compress to WebP and upload
picflow process --format webp --quality 85 ~/images/photo.jpg

# Process entire folder recursively
picflow batch ~/gallery --scale 50% --output ~/compressed_gallery

Advanced Configuration

Custom Processing

processing:
  default_quality: 90
  formats:
    webp:
      method: 6  # Compression method level
    jpeg:
      progressive: true  # Progressive JPEG

CLI Options

# Show help
picflow --help

# Override quality parameters in configuration
picflow process input.png --quality 75 --format jpeg

Contributing

Issues and PRs are welcome!

  • Code Style: Follow PEP8
  • Testing: Add pytest unit tests
  • Docs: Update English or Chinese documentation

License

Licensed 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

picflow-0.1.2.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

picflow-0.1.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file picflow-0.1.2.tar.gz.

File metadata

  • Download URL: picflow-0.1.2.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for picflow-0.1.2.tar.gz
Algorithm Hash digest
SHA256 053c8e6adb437a1f86703953dffeeeee1917e386687d905c2647439c38316868
MD5 c31324ba006019a978566f90ff446712
BLAKE2b-256 5d9e19b58599b08da020b433bf9843cd9d39a424bb5653e92c4a6be25f7e9732

See more details on using hashes here.

File details

Details for the file picflow-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: picflow-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for picflow-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6ad67ae624b4624b131f9208aa00bf05a52c16d7346c357e0bfb13feaf4300b
MD5 4229d04c6fecf2b657f226512623b683
BLAKE2b-256 6bc65f569dcea135884cbd35f1da16edf90e65e5ef7daa44dbc408a653ceb200

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