lumpenspace / climax

Clipboard Maximizer: a multiplatform python package to copy *files* to the OS clipboard.

climax: ᴄʟɪpboad ᴍᴀximizer.

🐙🖥️🐍➕👮🏻☃️🔧4️⃣👯‍♀️🫢📁(🚫🗃️)⏭️📋

(A mͫuͧltͭiͥplaͣtͭfoͦrͬmͫ python library and command line tool for copying 𝕬𝖈𝖙𝖚𝖆𝖑 𝕱𝖎𝖑𝖊𝖘 (ie, not their content) to the clipboard.)

• climax: ᴄʟɪpboad ᴍᴀximizer.
  • 1.1. Compatibility
  • 1.2. Installation
  • 1.3. Command Line
    • 1.3.1. Python API
  • 1.4. Contributing
  • 1.5. Blah

1.1. Compatibility

OS	🍎	🐧	🪟
Integration available	✅	✅	✅
Tested on device	✅	✅	🙊[1]
extra requirements	none	xclip	pwsh

macOS and Linux are supported and tested; the latter via xclip (apt-get install xclip)

Windows should be supported (I can run it on mac Powershell via pwsh), but I don't have a Windows machine to test it on.

1.2. Installation

Use pip, poetry, or your favorite python package manager to install the latest version of the clipboard maximiser: clipboard_maximizer.

1.3. Command Line

Install with pipx:

pipx install clipboard_maximizer

The script is available as climax:

climax --help # show help
climax file1 [file2] # copy file1 and file2 to the clipboard
climax file1 --clipboard xclip # use a specific clipboard.
            # xclip, powershell (custom script) and applescript 
            # are supported).

1.3.1. Python API

Install:

pip install clipboard_maximizer

Or, if you use poetry:

poetry add clipboard_maximizer

Use:

from clipboard_maximizer import copy_to_clipboard;

# copy file to clipboard
copy_to_clipboard("file1") 

# use a specific clipboard (see above)
copy_to_clipboard("file1", clipboard="xclip")

1.4. Contributing

poetry install
poetry run pytest

Contributions, in particular windows-related, are welcome.

If you plan to turn this into a full multiplatform clipboard manager, please fork the project and do so; I'll happily transfer the name to you.

1.5. Blah

License: MIT.