Clipstream
Clipstream is a tool for printing clipboard contents to the standard output as they change. It provides a convenient way to access the system clipboard from the command line.
On a Linux system with X and the XFIXES extension, clipstream receives clipboard updates without creating processes constantly for polling.
Installation
Clipstream can be installed with pip:
pip install clipstream
For use as a command-line tool, it is recommended to use pipx to install Clipstream in its own isolated environment:
pipx install clipstream
Usage as a Command-Line Tool
Clipstream can be run from the command line with the following command:
clipstream
This will print the current contents of the clipboard to the standard output as they change.
There are several options available for customizing the output of Clipstream:
-n, --newline Print a newline after each clipboard item.
-1, --one Print one clipboard item, then exit.
-i, --include-initial Include the initial clipboard item.
-s, --strip Strip whitespace from clipboard items.
-r, --polling-rate How often to poll the clipboard, in Hz (times per second).
-0, --null Print a null byte after each clipboard item.
-u, --unique Print only unique clipboard items.
Usage as a Library
Clipstream can also be used as a library in Python projects. To use Clipstream as a library, simply import the clipboard_stream function from the clipstream.stream module:
from clipstream.stream import clipboard_stream
The clipboard_stream function returns an asynchronous generator that yields the contents of the clipboard as they change.
Examples
Here are some examples of how Clipstream can be useful as a tool:
- Downloading files from copied links:
clipstream | xargs -I_ wget _
- Writing copied text to a file:
clipstream | tee -a copied_text_file
- Get clipboard history + selector with a preview:
clipstream --strip --unique -0 | fzf --read0 --preview 'echo -n {}' --bind 'enter:execute(echo {} | xclip -selection clipboard)'
Metadata
Release files for clipstream 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| clipstream-0.1.0.tar.gz | 414.0 kB | Without provenance | Details for clipstream-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| clipstream-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for clipstream-0.1.0-py3-none-any.whl |
Total release size: 959.7 kB
Release files / clipstream-0.1.0.tar.gz
| Download URL | clipstream-0.1.0.tar.gz |
|---|---|
| Size | 414.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4079f4dbef33524b3a8ba203dc543456e103d7908a4e9ed0c25eafd92171e645
|
|
BLAKE2b-256 checksum How to use checksums |
eac0b150fd1655338e3596783f04b928f005c612f4fd1d5727959c1bf44bf81b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.8 Linux/6.1.0
|
Release files / clipstream-0.1.0-py3-none-any.whl
| Download URL | clipstream-0.1.0-py3-none-any.whl |
|---|---|
| Size | 545.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
26072b043aab8bf465fa76fcc84182082046aed8e08dce86687bc20b676b27e5
|
|
BLAKE2b-256 checksum How to use checksums |
26a5600679c5239e01c2bc0fa90977d6fd5217c61806a353f38bbbf2ab931584
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.8 Linux/6.1.0
|
Security for clipstream 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.