Clipboard utilities for use with Python.
Project description
Description
Package for accessing the clipboard with Python.
Installation
pip install clip-util
Features
Windows Only
Allows you to set text and HTML to the clipboard on Windows.
Supported Clipboard Formats
- Text
- HTML
- RTF
Usage
Clipboard
Will open and close every time the values are set, or retrieved. It's better to use a context manager.
from clipboard import Clipboard
clipboard = Clipboard()
# Set Clipboard
clipboard['text'] = 'Hello World!'
# OR
clipboard.set_clipboard('text') = 'Hello World!'
# Get Clipboard
text = clipboard['text']
# OR
text = clipboard.get_clipboard('text')
# Supports HTML
clipboard['html'] = '<h1>Hello World</h1>'
Context Manager
from clipboard import Clipboard
with Clipboard() as clipboard:
# Set Clipboard
clipboard['text'] = 'Hello World!'
# OR
clipboard.set_clipboard('text') = 'Hello World!'
# Get Clipboard
text = clipboard['text']
# OR
text = clipboard.get_clipboard('text')
# HTML
clipboard['html'] = '<h1>Hello World</h1>'
Clipboard Formats
You can use clip-util
to access the clipboard formats directly.
ClipboardFormat
: Enum for clipboard formats.
ClipboardFormat.CF_HTML
: Represents HTML format.
ClipboardFormat.CF_RTF
: Represents RTF format.
from clipboard import Clipboard
from clipboard import ClipboardFormat
from clipboard import HTMLClipboard
with Clipboard() as clipboard:
# Get All Available Formats
format_ids: list[int] = clipboard.available_formats()
# Get Specific Format by ID
# Use parentheses to access the format
formats: list[ClipboardFormat] = []
for format_id in format_ids:
if format_id in ClipboardFormat:
format: ClipboardFormat = ClipboardFormat(format_id)
formats.append(format)
else:
# Format is not supported directly by this library
pass
# Get Specified Format by Name
# Use bracket notation to access the format
format_name: str
for format_name in [f.name for f in formats]:
if format_name in ClipboardFormat:
format: ClipboardFormat = ClipboardFormat[format_name]
name: str = format.name
else:
# Format is not supported directly by this library
pass
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
clip-util-0.1.18.tar.gz
(9.4 kB
view hashes)
Built Distribution
clip_util-0.1.18-py3-none-any.whl
(10.5 kB
view hashes)
Close
Hashes for clip_util-0.1.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe81a6430cfd1677a0f75d85c79dfef8ffac68ee048ce91b3a7673403146aa11 |
|
MD5 | 828ccd0179de7ca3fce630cec5f02e3c |
|
BLAKE2b-256 | 4dff7484c40f12ab175a6aff94a60d0bc0ec04bcc38593ad601a74d08ec0251d |