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.1.tar.gz (11.7 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.1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: picflow-0.1.1.tar.gz
  • Upload date:
  • Size: 11.7 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.1.tar.gz
Algorithm Hash digest
SHA256 d15d988dd12f5ae0b6cc0bd11dd181ea6c511fc31515d207fa0a96bdf93b4682
MD5 1fb10c86d9249c84e487c122d9f8d009
BLAKE2b-256 10dc02f19921979d544f2d5b3df1fec20075065c1767c729cf8ce353629344d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: picflow-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 90fc99276bc3844e7c1137f94d38526f6499a29cc0bacf1b972404e2842dfab8
MD5 86308276d21ab6d04c696529c20d162f
BLAKE2b-256 efe43d00471dc70df95a1aa1c92df601430df2f88494804c82f9f08c57c497bb

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