Skip to main content

A comprehensive Python utility library for S3 storage, media processing, file management, configuration, and logging

Project description

InoPyUtils

A comprehensive Python utility library designed for specific use-cases including S3-compatible storage operations, media processing, file management, configuration management, and logging.


Important Note

Active Development
This library is under active development and is not yet feature-complete. It was built to satisfy specific use-cases and may change without warning.

Not Production-Ready
Use at your own risk. Do not deploy this in production environments unless you fully understand its internals and have thoroughly tested it for your needs.

Contributions, feedback, and issue reports are welcome—but please be cautious if you plan to rely on this library for critical workloads.


Features

🗄️ S3-Compatible Storage (InoS3Helper)

  • Universal S3 Support: Compatible with AWS S3, Backblaze B2, DigitalOcean Spaces, Wasabi, MinIO, and other S3-compatible services
  • Async Operations: Fully asynchronous file upload/download operations
  • Automatic Retry: Configurable retry mechanism with exponential backoff
  • Flexible Authentication: Support for access keys, environment variables, and IAM roles
  • Advanced Features: Object listing, existence checking, deletion, and metadata support
from inopyutils import InoS3Helper

# Initialize with Backblaze B2
s3_client = InoS3Helper(
    aws_access_key_id='your_key_id',
    aws_secret_access_key='your_secret_key',
    endpoint_url='https://s3.us-west-004.backblazeb2.com',
    region_name='us-west-004',
    bucket_name='your-bucket',
    retries=5
)

# Upload and download files
await s3_client.upload_file('local_file.txt', 'remote/file.txt')
await s3_client.download_file('remote/file.txt', 'downloaded_file.txt')

📁 File Management (InoFileHelper)

  • Archive Operations: ZIP compression and extraction with customizable settings
  • File Operations: Move, copy, remove files and folders with safety checks
  • Batch Processing: Automatic batch name incrementing for organized workflows
  • File Analysis: Count files recursively, get last modified files
  • Media Validation: Validate image and video files with format conversion support
from inopyutils import InoFileHelper
from pathlib import Path

# Zip a folder with compression
await InoFileHelper.zip(
    to_zip=Path("source_folder"),
    path_to_save=Path("output"),
    zip_file_name="archive.zip",
    compression_level=5
)

# Copy files with renaming
InoFileHelper.copy_files(
    from_path=Path("source"),
    to_path=Path("destination"),
    rename_files=True,
    prefix_name="ProcessedFile"
)

🎨 Media Processing (InoMediaHelper)

  • Video Processing: FFmpeg-based video conversion with resolution and FPS control
  • Image Processing: Pillow-based image validation, resizing, and format conversion
  • HEIF Support: Handle HEIF/HEIC image formats with automatic registration
  • Quality Control: Configurable JPEG quality and resolution limits
  • Format Validation: Comprehensive media file validation and conversion
from inopyutils import InoMediaHelper
from pathlib import Path

# Convert and resize image
await InoMediaHelper.image_validate_pillow(
    input_path=Path("input.heic"),
    output_path=Path("output.jpg"),
    max_res=2048,
    jpg_quality=90
)

# Process video with resolution/FPS limits
await InoMediaHelper.video_convert_ffmpeg(
    input_path=Path("input.mp4"),
    output_path=Path("output.mp4"),
    change_res=True,
    max_res=1920,
    change_fps=True,
    max_fps=30
)

⚙️ Configuration Management (InoConfigHelper)

  • INI File Support: Read and write INI-based configuration files
  • Type Safety: Dedicated methods for strings and booleans
  • Debug Mode: Optional debug logging for configuration operations
  • Auto-Save: Automatic saving after configuration changes
from inopyutils import InoConfigHelper

config = InoConfigHelper('config/app.ini')

# Get configuration values with fallbacks
api_key = config.get('api', 'key', fallback='default_key')
debug_mode = config.get_bool('app', 'debug', fallback=False)

# Set configuration values
config.set('api', 'endpoint', 'https://api.example.com')

📝 Structured Logging (InoLogHelper)

  • JSON-Lines Format: Structured logging in JSONL format
  • Automatic Batching: Automatic log file batch naming and rotation
  • Categorized Logging: INFO, WARNING, ERROR categories
  • Timestamped Entries: ISO format timestamps for all log entries
  • Flexible Data: Log arbitrary dictionary data with messages
from inopyutils import InoLogHelper, LogCategory
from pathlib import Path

logger = InoLogHelper(Path("logs"), "MyApp")

# Log with automatic categorization
logger.add({"status": "success", "processed": 100}, "Batch completed")

# Log with explicit category
logger.add({"error": "Connection timeout"}, "API failed", LogCategory.ERROR)

Installation

# Install from PyPI
pip install inopyutils

# Install locally for development:
git clone https://github.com/nobandegani/InoPyUtils.git
cd InoPyUtils
pip install -e .

Dependencies

  • pillow: Image processing
  • pillow_heif: HEIF/HEIC image format support
  • opencv-python: Video processing capabilities
  • aioboto3: Async AWS S3 operations
  • aiofiles: Async file operations
  • botocore: AWS core functionality and exception handling
  • inocloudreve: Cloud storage integration

License

Mozilla Public License Version 2.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inopyutils-1.1.2.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

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

inopyutils-1.1.2-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file inopyutils-1.1.2.tar.gz.

File metadata

  • Download URL: inopyutils-1.1.2.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for inopyutils-1.1.2.tar.gz
Algorithm Hash digest
SHA256 641d2ca558b68c23d2053ad1b4693f08890d19c7d94ef78fe4879fbfd3bafada
MD5 66f5250e21704223f29175c375c3256c
BLAKE2b-256 0f6348c737bd1f21bf0987918148430ef14e8786d86900aa3f2a54bc773d5e97

See more details on using hashes here.

File details

Details for the file inopyutils-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: inopyutils-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for inopyutils-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b57c3d00e425725082facc01251861ae2e69e3d0abdb7631ac52f14aa7dc68bb
MD5 f3acf8d95b4a1c2610efbad9f895d988
BLAKE2b-256 93c1ce6c4b2c58be640635e40531b9e6c1943ed6c379c27ee0767f106194c653

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