Swiss Knife

A Python package that provides essential automation tools with a focus on safety, security, and ease of use.

Features

File Management

• Duplicate Detection: Find and remove duplicate files using cryptographic hashes (MD5, SHA1, SHA256, SHA512)
• Bulk Renaming: Rename files in bulk using regex patterns with safety checks and dry-run mode

Text Processing

• CSV Conversion: Convert CSV files to JSON/XML with intelligent type inference and validation

Security & Automation

• Password Generation: Generate secure passwords with customizable policies and strength analysis

Utilities

• Data Helpers: Parse booleans and environment variables, convert key styles, validate UUIDs and HTTP status codes, and decode base64 text

Standalone Scripts

The scripts/ directory contains standalone scripts that are not part of the installable package. They are not installed by pip install swiss-knife-py and may have their own requirements.txt files with heavier dependencies (e.g. Pillow, pydub, psutil, qrcode). These scripts predate the packaged modules, have not been audited for divergence, and overlap with functionality now provided by swiss_knife.*. Use the installable package for the supported API and CLI tools listed above.

Each subdirectory has its own README. These scripts are retained for reference and standalone use; the packaged modules under swiss_knife/ are the maintained, tested, and recommended APIs.

Quick Start

Installation

# Basic installation
pip install swiss-knife-py

# With XML processing support (recommended for security)
pip install swiss-knife-py[xml]

# With development tools
pip install swiss-knife-py[dev]

Note on the sk command: The sk name may conflict with other tools (e.g. Sketch on macOS). See the Installation Guide for details.

Command Line Usage

# Find duplicate files
sk-duplicates ~/Documents --algorithm sha256 --min-size 1048576

# Convert CSV to JSON
sk-csv data.csv --format json --output data.json --pretty

# Generate secure password
sk-password --length 16 --exclude-ambiguous

# Bulk rename files
sk-rename 'IMG_(\d+)' 'photo_\1' ~/Pictures --dry-run

Python API Usage

from swiss_knife.file_management.duplicate_finder import find_duplicates
from swiss_knife.file_management.bulk_renamer import bulk_rename
from swiss_knife.text_processing.csv_converter import convert_csv
from swiss_knife.automation.password_generator import generate_password
from swiss_knife.utilities import get_env_int, convert_keys_to_camel_case

# Find duplicates
duplicates = find_duplicates(["/path/to/search"], algorithm="sha256")
print(f"Found {len(duplicates)} duplicate groups")

# Convert CSV to JSON
convert_csv("data.csv", "json", output_path="data.json", pretty=True)

# Generate secure password
password = generate_password(length=16, include_symbols=True)
print(f"Generated password: {password}")

# Bulk rename with safety checks
renamed_count = bulk_rename(r"IMG_(\d+)", r"photo_\1", "/path/to/images", dry_run=True)

# Parse helpers
retry_count = get_env_int("RETRY_COUNT", default=3)
payload = convert_keys_to_camel_case({"first_name": "Alice"})

Security Features

Swiss Knife prioritizes security with multiple safety mechanisms:

• Safe Defaults: All destructive operations require explicit confirmation
• Input Validation: Comprehensive validation prevents injection attacks
• Path Safety: Protection against path traversal vulnerabilities
• Memory Limits: Configurable limits prevent memory exhaustion
• Dry Run Mode: Test operations before executing them
• Cryptographic Security: Uses secrets module for secure randomness

Development

# Clone the repository
git clone https://github.com/ayoub3bidi/swiss-knife.git
cd swiss-knife

# Install in development mode
pip install -e .[dev,all]

# Run tests
pytest

# Run linting
ruff check swiss_knife/

# Run security checks
bandit -r swiss_knife/