philiprehberger-clipboard 0.3.0

Cross-platform clipboard copy and paste in one function call.

philiprehberger-clipboard

Cross-platform clipboard copy and paste in one function call.

Installation

pip install philiprehberger-clipboard

Usage

from philiprehberger_clipboard import copy, paste

copy("Hello, clipboard!")
text = paste()
print(text)  # Hello, clipboard!

Clearing and checking

from philiprehberger_clipboard import clear, copy, equals

copy("secret")
equals("secret")  # True
equals("other")   # False

clear()
equals("")        # True

Detect availability

from philiprehberger_clipboard import copy, is_available

if is_available():
    copy("hello")
else:
    print("install xclip / xsel / wl-clipboard to enable copy")

CLI

Copy text from stdin:

echo "Hello" | python -m philiprehberger_clipboard copy

Paste clipboard contents to stdout:

python -m philiprehberger_clipboard paste

Or use the installed script:

echo "Hello" | clipboard copy
clipboard paste

API

Function	Description
copy(text: str) -> None	Copy a string to the system clipboard
paste() -> str	Read a string from the system clipboard
is_available() -> bool	Return True if a clipboard backend is detected on the current platform
clear() -> None	Clear the clipboard (equivalent to copy(""))
equals(text: str) -> bool	Return True if the clipboard contains exactly text; non-destructive, returns False when backend is unavailable
ClipboardError	Raised when clipboard tool is unavailable or operation fails

Platform support

Platform	Copy	Paste
Windows	clip.exe	PowerShell Get-Clipboard
macOS	pbcopy	pbpaste
Linux (X11)	xclip or xsel	xclip or xsel
Linux (Wayland)	wl-copy	wl-paste

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT