Skip to main content

Save clipboard content (text and images) to files with smart format detection

Project description

ClipDrop

PyPI version Python Downloads License: MIT GitHub issues

Save clipboard content to files with one command. ClipDrop automatically detects formats (JSON, Markdown, CSV), suggests appropriate extensions, prevents accidental overwrites, and provides rich visual feedback.

๐Ÿ“‹ Problem We're Solving

The Pain: macOS users face a cumbersome 6-step workflow to save clipboard content:

  1. Copy content to clipboard
  2. Open text editor or image application
  3. Paste content
  4. Navigate to save location
  5. Choose file name and format
  6. Click save

Our Solution: Transform those 6 steps into 1 simple command โ†’ clipdrop filename

This workflow interruption is especially painful for:

  • Developers saving code snippets, API responses, or terminal outputs
  • Product Managers capturing screenshots and meeting notes
  • Content Creators storing drafts, research clips, and visual content
  • Students organizing research notes and screenshots

Features

  • Web Content Support: Save content from web pages with embedded images ๐ŸŒ
  • PDF Creation: Save mixed content (text + images) as PDF to preserve context ๐Ÿ“„
  • HTML Clipboard Parsing: Automatically extracts text and images from web copies
  • Image Support: Save images from clipboard (PNG, JPG, GIF, BMP, WebP) ๐Ÿ“ท
  • Smart Format Detection: Automatically detects JSON, Markdown, CSV, PDF, HTML, and image formats
  • Extension Auto-Suggestion: No extension? ClipDrop suggests the right one
  • Content Priority: Intelligently handles mixed content (HTML โ†’ PDF, text + image โ†’ PDF)
  • Safe by Default: Interactive overwrite protection (bypass with --force)
  • Preview Mode: See content before saving (text with syntax highlighting, images with dimensions)
  • Rich CLI: Beautiful, informative output with colors and icons
  • Performance: Caches clipboard content for speed (<200ms operations)
  • Image Optimization: Automatic compression for PNG/JPEG formats
  • Large File Support: Handles files up to 100MB with size warnings
  • Unicode Support: Full international character support

๐Ÿ“ฆ Installation

Quick Install

pip install clipdrop

Alternative Installation Methods

# Using uv (fast Python package manager)
uv add clipdrop

# Using pipx (for isolated environments)
pipx install clipdrop

From Source

# Clone the repository
git clone https://github.com/prateekjain24/clipdrop.git
cd clipdrop

# Install with uv
uv pip install -e .

# Or with pip
pip install -e .

Usage

Basic Usage

# Save clipboard to file (auto-detects format)
clipdrop notes              # โ†’ notes.txt (text only)
clipdrop screenshot         # โ†’ screenshot.png (image only)
clipdrop document           # โ†’ document.pdf (mixed content auto-detected)
clipdrop data               # โ†’ data.json (if JSON detected)
clipdrop readme             # โ†’ readme.md (if Markdown detected)

# Specify extension explicitly
clipdrop report.pdf         # Save any content as PDF
clipdrop photo.jpg          # Save as JPEG
clipdrop diagram.png        # Save as PNG
clipdrop config.yaml        # Save as YAML

Options

# Force overwrite without confirmation
clipdrop notes.txt --force
clipdrop notes.txt -f

# Preview content before saving (with syntax highlighting for text, dimensions for images)
clipdrop data.json --preview
clipdrop screenshot.png -p

# Force text mode when both image and text are in clipboard
clipdrop notes.txt --text
clipdrop notes.txt -t

# Show version
clipdrop --version

# Get help
clipdrop --help

Examples

Save copied text

# Copy some text, then:
clipdrop notes
# โœ… Saved 156 B to notes.txt

Save web article with images

# Copy article from Medium, Wikipedia, etc., then:
clipdrop article
# ๐Ÿ“„ HTML with images detected. Creating PDF: article.pdf
# โœ… Created PDF from HTML (2048 chars, 5 images, 245.3 KB) at article.pdf

Auto-detect JSON and pretty-print

# Copy JSON data, then:
clipdrop config
# ๐Ÿ“ Auto-detected format. Saving as: config.json
# โœ… Saved 2.3 KB to config.json

Preview with syntax highlighting

clipdrop script.py --preview
# Shows colored preview with line numbers
# Save this content? [Y/n]:

Save copied image

# Copy an image (screenshot, etc.), then:
clipdrop screenshot
# ๐Ÿ“ท Auto-detected image format. Saving as: screenshot.png
# โœ… Saved image (1920x1080, 245.3 KB) to screenshot.png

Handle mixed content

# When both image and text are in clipboard:
clipdrop document         # Auto-creates PDF with both (NEW!)
clipdrop content.png      # Save image only
clipdrop content --text   # Forces text mode

Create PDFs from clipboard

# Mixed content (text + image) โ†’ PDF automatically
clipdrop notes            # Has both? โ†’ notes.pdf

# Explicitly create PDF from any content
clipdrop report.pdf       # Always creates PDF

# PDF preserves content order (WYCWYG - What You Copy is What You Get)
# โ€ข Text with code โ†’ formatted in PDF
# โ€ข Screenshots โ†’ embedded in PDF
# โ€ข Mixed notes โ†’ structured document

๐Ÿ”ง Development

Setup Development Environment

# Clone the repository
git clone https://github.com/prateekjain24/clipdrop.git
cd clipdrop

# Install with dev dependencies
uv pip install -e .[dev]

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov --cov-report=term-missing

# Run specific test file
pytest tests/test_clipboard.py

Code Quality

# Format code
black src tests

# Lint code
ruff check .

# Type checking (if using mypy)
mypy src

Project Status

Completed Features (Sprints 1-3) โœ…

  • Project setup with uv package manager
  • CLI skeleton with Typer
  • Clipboard text and image reading with caching
  • File writing with atomic operations
  • Extension detection for text and image formats
  • Overwrite protection
  • Rich success/error messages
  • JSON, Markdown, CSV format detection
  • Path validation and sanitization
  • Image clipboard support (PNG, JPG, GIF, BMP, WebP)
  • Content priority logic (image > text, with --text override)
  • Image optimization with format-specific compression
  • Comprehensive test suite (89 tests)
  • Preview mode with syntax highlighting (text) and dimensions (images)

Enhanced Features ๐ŸŒŸ

  • Custom exception hierarchy for better error handling
  • Advanced clipboard operations (stats, monitoring, binary detection, images)
  • Enhanced file operations (atomic writes, backups, compression)
  • Image format conversion (RGBAโ†’RGB for JPEG)
  • Performance optimizations with content caching
  • Smart format detection for images and text

Future Roadmap (Sprint 4) ๐Ÿšง

  • PyPI package release
  • Performance profiling for large files
  • Cross-platform support (Windows, Linux)
  • Configuration file support

๐Ÿ—๏ธ Architecture

clipdrop/
โ”œโ”€โ”€ src/clipdrop/
โ”‚   โ”œโ”€โ”€ __init__.py         # Version management
โ”‚   โ”œโ”€โ”€ main.py            # CLI entry point
โ”‚   โ”œโ”€โ”€ clipboard.py       # Clipboard operations (text + images)
โ”‚   โ”œโ”€โ”€ files.py           # File operations
โ”‚   โ”œโ”€โ”€ images.py          # Image-specific operations
โ”‚   โ”œโ”€โ”€ detect.py          # Format detection
โ”‚   โ”œโ”€โ”€ pdf.py             # PDF creation (NEW)
โ”‚   โ””โ”€โ”€ exceptions.py      # Custom exceptions
โ”œโ”€โ”€ tests/                 # Comprehensive test suite (124 tests)
โ”‚   โ”œโ”€โ”€ test_clipboard.py  # 27 tests
โ”‚   โ”œโ”€โ”€ test_files.py      # 37 tests
โ”‚   โ”œโ”€โ”€ test_images.py     # 25 tests
โ”‚   โ””โ”€โ”€ test_pdf.py        # 35 tests (NEW)
โ”œโ”€โ”€ pyproject.toml         # Modern Python packaging
โ””โ”€โ”€ README.md              # This file

๐Ÿ“ Requirements

  • Python: 3.10, 3.11, 3.12, or 3.13
  • OS: macOS 10.15+ (initial target)
  • Dependencies:
    • typer[all] >= 0.17.4
    • rich >= 14.1.0
    • pyperclip >= 1.9.0
    • Pillow >= 11.3.0
    • reportlab >= 4.0.0

๐Ÿ“„ License

MIT License - See LICENSE file for details.

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues

Found a bug or have a feature request? Please open an issue on GitHub Issues.


Current Version: 0.3.0 | Status: Available on PyPI

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

clipdrop-0.4.0.tar.gz (48.6 kB view details)

Uploaded Source

Built Distribution

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

clipdrop-0.4.0-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file clipdrop-0.4.0.tar.gz.

File metadata

  • Download URL: clipdrop-0.4.0.tar.gz
  • Upload date:
  • Size: 48.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.16

File hashes

Hashes for clipdrop-0.4.0.tar.gz
Algorithm Hash digest
SHA256 bbd0237c028afb59dea18ab715b406daa90e2757ec52b2513f28d8ef88b41f4c
MD5 a16888e0ccf76bc8ebe763d6424f09ad
BLAKE2b-256 891d2c9e73d63f0df0728abacb9f70373f7cd6c2cdb357f3050503be2f37209a

See more details on using hashes here.

File details

Details for the file clipdrop-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: clipdrop-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.16

File hashes

Hashes for clipdrop-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b4a966c84db55a1bdc40bac407ade7dc1744fce486097d34ce690b16fd214d5
MD5 6582e15892cd66b6f360c2ddb96c34d0
BLAKE2b-256 903d9d0b228e8f10d3f5329c43086d18fb8f2cc40ad164b51f034bbd0907867b

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