Skip to main content

A comprehensive collection of Python automation tools

Project description

Swiss Knife

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

Python versions CI Security codecov Ruff

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.

Directory Contents
scripts/automation/ Standalone automation scripts
scripts/convert/ File format conversion utilities
scripts/development_tools/ Developer workflow helpers
scripts/file_management/ File operations (predates the packaged file_management module)
scripts/network_web/ Networking and web utilities
scripts/system_utilities/ System administration scripts
scripts/text_processing/ Text transformation scripts (predates the packaged text_processing module)
scripts/utilities/ General-purpose helpers (predates the packaged utilities module)

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/

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

swiss_knife_py-0.2.0.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

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

swiss_knife_py-0.2.0-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file swiss_knife_py-0.2.0.tar.gz.

File metadata

  • Download URL: swiss_knife_py-0.2.0.tar.gz
  • Upload date:
  • Size: 29.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for swiss_knife_py-0.2.0.tar.gz
Algorithm Hash digest
SHA256 53aedce6a9becda418debc74ac0ee36149c7cb5fd9b26bf865abde91e700c902
MD5 308c655f13ea946049fe0c2d3ce28073
BLAKE2b-256 9f40daee8594782eaba959cd62f8b7ffdf4d7d29949975e90bc3c6c2bcd4fd51

See more details on using hashes here.

Provenance

The following attestation bundles were made for swiss_knife_py-0.2.0.tar.gz:

Publisher: release.yml on ayoub3bidi/swiss-knife

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file swiss_knife_py-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: swiss_knife_py-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for swiss_knife_py-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a52e3f99bd2bc5c9b7e44461a02c29f4fd1ad2dffa79e9645a4906faa7199d0
MD5 191b4e735bbcc8d8f25c83272167d97d
BLAKE2b-256 2975044a0c5f1b1d62c4d7b79dfdec366df16229f3a08aeacaf3ad6b5ef7f0da

See more details on using hashes here.

Provenance

The following attestation bundles were made for swiss_knife_py-0.2.0-py3-none-any.whl:

Publisher: release.yml on ayoub3bidi/swiss-knife

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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