https://github.com/jaraco/jaraco.clipboard

https://github.com/jaraco/jaraco.clipboard

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jaraco/jaraco.clipboard
• Owner: jaraco
• License: mit
• Created: 2015-11-19T02:22:29.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T22:20:54.000Z (2 months ago)
• Last Synced: 2024-09-13T14:21:14.357Z (about 2 months ago)
• Language: Python
• Size: 380 KB
• Stars: 19
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: NEWS.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/pypi/v/jaraco.clipboard.svg

   :target: https://pypi.org/project/jaraco.clipboard

.. image:: https://img.shields.io/pypi/pyversions/jaraco.clipboard.svg

.. image:: https://github.com/jaraco/jaraco.clipboard/actions/workflows/main.yml/badge.svg

   :target: https://github.com/jaraco/jaraco.clipboard/actions?query=workflow%3A%22tests%22

   :alt: tests

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json

    :target: https://github.com/astral-sh/ruff

    :alt: Ruff

.. image:: https://readthedocs.org/projects/jaracoclipboard/badge/?version=latest

   :target: https://jaracoclipboard.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/skeleton-2024-informational

   :target: https://blog.jaraco.com/skeleton

The only clipboard library for Python that supports text on all

three major platforms plus HTML on MacOS and HTML and images

on Windows.

Similar to `pyperclip `_

and `clipboard `_

and `xerox `_ except attempts

to support more formats than just text.

This library is just a thin wrapper around the best platform implementations:

- pyperclip for Linux

- richxerox for MacOS

- jaraco.windows for Windows

Usage

=====

``jaraco.clipboard`` supplies several functions in the clipboard module.

The most common are the copy and paste functions:

.. code-block:: python

    from jaraco import clipboard

    clipboard.copy('some text')

    clipboard.paste() == 'some text'

Other functions include ``copy/paste`` ``html`` and ``image``.

If not implemented on your platform, the functions will raise

NotImplementedError.