pythontk

PYTHONTK (Python Toolkit)

A collection of Python utility functions for file operations, text processing, and basic image/video manipulation. Provides helper classes and convenience functions for common programming tasks.

Features

pythontk provides utility functions organized into focused modules:

• File Operations: Directory listing, file reading/writing, and path utilities
• Text Processing: String sanitization, formatting, and text manipulation
• Data Filtering: List and dictionary filtering with pattern matching
• Image Utilities: Basic image operations and texture map processing (requires Pillow)
• Video Utilities: Simple video operations using FFmpeg
• Math Utilities: Basic mathematical helper functions
• Core Utilities: Decorators and helper classes for common patterns

Installation

Python Requirements:

• Python 3.7+

Installation:

pip install pythontk

Development Installation:

git clone https://github.com/m3trik/pythontk.git
cd pythontk
pip install -e .

Optional Dependencies:

• PIL (Pillow) for image operations
• numpy for mathematical operations
• FFmpeg for video utilities

Usage Examples

File Operations

import pythontk as ptk

# Get directory contents with filtering
files = ptk.filter_list(
    ptk.get_dir_contents('/path/to/directory'),
    inc=['*.py', '*.txt'], exc='*temp*'
)

# Path formatting
clean_path = ptk.format_path('/path\\to/file.txt', style='forward')

Text Processing

# String sanitization
clean_name = ptk.sanitize('My Asset Name!@#', replacement_char='_')
# Result: 'My_Asset_Name'

# Text formatting
formatted = ptk.format_string('hello world', style='title')
# Result: 'Hello World'

Basic Image Operations

# Requires PIL/Pillow
from pythontk import ImgUtils

# Create image from channels
img = ImgUtils.pack_channels({
    'R': red_channel_path,
    'G': green_channel_path,
    'B': blue_channel_path
})

# Get image dimensions
width, height = ImgUtils.get_image_size('image.jpg')

Data Processing

# Filter lists and dictionaries
filtered_data = ptk.filter_dict(
    data, inc=['name', 'version'], keys=True
)

# List filtering with patterns
python_files = ptk.filter_list(
    file_list, inc=['*.py'], exc=['*test*']
)

Module Overview

Core Utilities (core_utils)

Basic helper classes and decorators:

• HelpMixin: Documentation helper
• cached_property: Property caching decorator
• @listify: Convert returns to lists

File Utilities (file_utils)

File system operations:

• get_dir_contents(): Directory listing with filtering
• get_file_contents(): Read file contents
• create_dir(): Directory creation
• format_path(): Path formatting

String Utilities (str_utils)

Text processing functions:

• sanitize(): Clean strings for filenames
• format_string(): Text case formatting
• remove_chars(): Character removal

Image Utilities (img_utils)

Basic image operations (requires PIL):

• get_image_size(): Get image dimensions
• pack_channels(): Combine image channels
• get_channels(): Extract image channels

Video Utilities (vid_utils)

Simple video operations (requires FFmpeg):

• extract_frames(): Extract video frames
• get_video_info(): Video metadata

Math Utilities (math_utils)

Mathematical helper functions for common calculations.

Dynamic Imports

pythontk uses a dynamic attribute resolution system allowing direct access to utility functions:

import pythontk as ptk

# These are equivalent:
ptk.sanitize('text')           # Direct access
ptk.str_utils.sanitize('text') # Module-specific access

Contributing

This is a utility collection for common Python tasks. Contributions that add useful, focused utility functions are welcome.

License

This project is licensed under the MIT License.