Skip to main content

Cross-platform clipboard utilities supporting both binary and text data.

Project description

This project Has Moved

Please see https://pypi.org/project/pyclip/

Pyperclip3

Cross-platform clipboard utilities supporting both binary and text data.

Some key features include:

  • A cross-platform API (supports MacOS, Windows, Linux)
  • Can handle arbitrary binary data
  • On Windows, some additional clipboard formats are supported

Installation

Requires python 3.7+

pip install pyperclip3

Usage

pyperclip3 can be used in Python code

import pyperclip3

pyperclip3.copy("hello clipboard") # copy data to the clipboard
cb_data = pyperclip3.paste() # retrieve clipboard contents 
print(cb_data)

pyperclip3.clear() # clears the clipboard contents
assert not pyperclip3.paste()

Or a CLI

# paste clipboard contents to stdout
python -m pyclip paste

# load contents to the clipboard from stdin
python -m pyperclip3 copy < myfile.text
# same as above, but pipe from another command
some-program | python -m pyperclip3 copy

Installing via pip also provides console script pyclip:

pyclip copy < my_file.txt

This library implements functionality for several platforms and clipboard utilities.

  • MacOS
  • Windows
  • Linux (with xclip)

If there is a platform or utility not currently listed, please request it by creating an issue.

Platform specific notes/issues

Windows

  • On Windows, the pywin32 package is installed as a requirement.
  • On Windows, additional clipboard formats are supported, including copying from a file (like if you right-click copy from File Explorer)

MacOS

MacOS has support for multiple backends. By default, the pasteboard package is used.

pbcopy/pbpaste can also be used as a backend, but does not support arbitrary binary data, which may lead to data being lost on copy/paste. This backend may be removed in a future release.

Linux

Linux requires xclip to work (which means you must also use X). Install with your package manager, e.g. sudo apt install xclip

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

pyperclip3-0.4.1.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

pyperclip3-0.4.1-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file pyperclip3-0.4.1.tar.gz.

File metadata

  • Download URL: pyperclip3-0.4.1.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for pyperclip3-0.4.1.tar.gz
Algorithm Hash digest
SHA256 3d99793b610431624259190f48d60deb630643472f28e8012d425d8212acd27b
MD5 2cbc5d80ce5396ab09753eed41ab5ec8
BLAKE2b-256 29c439e7514d839255f8a6a41d98eefe53515d27a72f307359bb751e245a23b8

See more details on using hashes here.

File details

Details for the file pyperclip3-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: pyperclip3-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for pyperclip3-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4631290a04858313f410d72cc6f72cbfe732eca4572124b1c1ae98f1eb779451
MD5 1b955fd42adf44c4796829bb2f3c7567
BLAKE2b-256 56098f71b75e1019670322fa55a3b94e01af8b8097dbd039331582a56a785999

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page