clipman


Nameclipman JSON
Version 3.2.3 PyPI version JSON
download
home_page
SummaryPython3 module for working with clipboard. Created because pyperclip is discontinued.
upload_time2024-02-23 02:52:03
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMPL 2.0 License
keywords clipman clipboard copy paste xclip
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!-- # Copyright (c) 2023 Nikita Beloglazov -->
<!-- License: Mozilla Public License 2.0 -->
# ✨ Clipman
[![License: Mozilla Public License 2.0](https://img.shields.io/badge/License:_MPL_2.0-blueviolet?logo=googledocs&logoColor=white&style=for-the-badge)](https://mozilla.org/en-US/MPL/2.0)
[![linting: pylint](https://img.shields.io/badge/Linting:_pylint-success?logo=azurefunctions&logoColor=white&style=for-the-badge)](https://pylint.pycqa.org/en/latest/)
[![maintainer: NikitaBeloglazov](https://img.shields.io/badge/Maintainer:_.%E2%80%A2%C2%B0%E2%97%8F%E2%9D%A4%EF%B8%8F%20NikitaBeloglazov%20Software%20Foundation%20%E2%9D%A4%EF%B8%8F%E2%97%8F%C2%B0%E2%80%A2.-informational?logoColor=white&style=for-the-badge&logo=github)](https://github.com/NikitaBeloglazov)

__Python3 module for working with clipboard. Created because pyperclip is discontinued.__

__Mostly made for [✨ YTCON](https://github.com/NikitaBeloglazov/ytcon)__

# 📘 Features:
* Easy use and simple architecture by KISS
* User-friendly
* No additional modules
* Supports many engines
* We use PyLint and we comment all our code
* Active development
* Just good dev 😇

# 👽 Using
```python3
import clipman
clipman.init() # Just initialize module

# Set text to clipboard
clipman.set("test")

# Get text from clipboard. So simple!:)
print(clipman.get())
Out: 'test'
```
__Also you can use `clipman.copy("ytcon")` and `clipman.paste()` as from pyperclip!:)__
## Catching errors
* If you want to catch all errors from the module, use `clipman.exceptions.ClipmanBaseException`:
```python3
import clipman
try:
  clipman.init()
  print(clipman.paste())
except clipman.exceptions.ClipmanBaseException as e:
  print(e)
```
* And if you want to catch specific module error, use its name.

# 🚀 Install
### Clipman is avalible on PyPI - https://pypi.org/project/clipman/

### Install it as pip package
```shell
pip3 install clipman
```

# 🔌 Support
__•‎ 🟩 Linux - FULL SUPPORT, native in KDE__.
In other cases, some additional dependencies are required

__•‎ 🟩 Android - FULL SUPPORT in Termux__, some additional deps needed too

__•‎ 🟩 BSD Systems - Works__ on __FreeBSD / GhostBSD__ and OpenBSD / FuguIta, deps same as Linux

__•‎ 🟩 Windows - Works__ natively

__•‎ 🟩 MacOS - Works__ on macOS HighSierra 10.13

# 📙 Additional deps
__Unstead zypper you need to use system package manager: pkg, apt, dnf, pacman, etc__

`- = - = -`
### 🐧 On Linux/BSD - ▶️ KDE (any display server)

- Native support. No additional dependencies are needed.

It seems that all dependencies are listed below are already installed by default in all KDE distributions
###### The only minimum requirement is dbus, klipper (which is now built-in into KDE), and an `dbus-python`

### 🐧 On Linux/BSD - X11
- Install `xsel` or `xclip` package

Example: _sudo zypper install xsel_ __OR__ _sudo zypper install xclip_

`- = - = -`
### 🐧 On Linux/BSD - Wayland
- Install `wl-clipboard` package

Example: _sudo zypper install wl-clipboard_

`- = - = -`
### 🐸 On Android
Clipboard works only in Termux.
And you need install additional deps in it.
* Install ```Termux:API``` from F-Droid
* Run ```pkg install termux-api```
* Check it - run ```termux-clipboard-get```

# License
This code is under [Mozilla Public License Version 2.0](/../../blob/main/LICENSE).

# Contribution / Issues
📕 __[!!] If you encouter an error, please read the error text very closely.
The module is specially written so that errors give you a complete answer even if you a lamer__

* 🥼 __Pull requests are welcome!__
* 🌈 Feel free to write Issues! The developer can answer you in the following languages: Ukrainian, English, Russian.
* Don't forget to attach version (`pip3 show clipman`) and error text with `clipman.init(debug=True)` :)
* ⏩ To speed up the process write to [maintainer](https://github.com/NikitaBeloglazov)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "clipman",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "clipman,clipboard,copy,paste,xclip",
    "author": "",
    "author_email": "NikitaBeloglazov <nnikita.beloglazov@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/7e/c1/be141d65cfd2a48c0be4db6408fb53ef383e3e27ee57bbde17f635dd8562/clipman-3.2.3.tar.gz",
    "platform": null,
    "description": "<!-- # Copyright (c) 2023 Nikita Beloglazov -->\n<!-- License: Mozilla Public License 2.0 -->\n# \u2728 Clipman\n[![License: Mozilla Public License 2.0](https://img.shields.io/badge/License:_MPL_2.0-blueviolet?logo=googledocs&logoColor=white&style=for-the-badge)](https://mozilla.org/en-US/MPL/2.0)\n[![linting: pylint](https://img.shields.io/badge/Linting:_pylint-success?logo=azurefunctions&logoColor=white&style=for-the-badge)](https://pylint.pycqa.org/en/latest/)\n[![maintainer: NikitaBeloglazov](https://img.shields.io/badge/Maintainer:_.%E2%80%A2%C2%B0%E2%97%8F%E2%9D%A4%EF%B8%8F%20NikitaBeloglazov%20Software%20Foundation%20%E2%9D%A4%EF%B8%8F%E2%97%8F%C2%B0%E2%80%A2.-informational?logoColor=white&style=for-the-badge&logo=github)](https://github.com/NikitaBeloglazov)\n\n__Python3 module for working with clipboard. Created because pyperclip is discontinued.__\n\n__Mostly made for [\u2728 YTCON](https://github.com/NikitaBeloglazov/ytcon)__\n\n# \ud83d\udcd8 Features:\n* Easy use and simple architecture by KISS\n* User-friendly\n* No additional modules\n* Supports many engines\n* We use PyLint and we comment all our code\n* Active development\n* Just good dev \ud83d\ude07\n\n# \ud83d\udc7d Using\n```python3\nimport clipman\nclipman.init() # Just initialize module\n\n# Set text to clipboard\nclipman.set(\"test\")\n\n# Get text from clipboard. So simple!:)\nprint(clipman.get())\nOut: 'test'\n```\n__Also you can use `clipman.copy(\"ytcon\")` and `clipman.paste()` as from pyperclip!:)__\n## Catching errors\n* If you want to catch all errors from the module, use `clipman.exceptions.ClipmanBaseException`:\n```python3\nimport clipman\ntry:\n  clipman.init()\n  print(clipman.paste())\nexcept clipman.exceptions.ClipmanBaseException as e:\n  print(e)\n```\n* And if you want to catch specific module error, use its name.\n\n# \ud83d\ude80 Install\n### Clipman is avalible on PyPI - https://pypi.org/project/clipman/\n\n### Install it as pip package\n```shell\npip3 install clipman\n```\n\n# \ud83d\udd0c Support\n__\u2022\u200e \ud83d\udfe9 Linux - FULL SUPPORT, native in KDE__.\nIn other cases, some additional dependencies are required\n\n__\u2022\u200e \ud83d\udfe9 Android - FULL SUPPORT in Termux__, some additional deps needed too\n\n__\u2022\u200e \ud83d\udfe9 BSD Systems - Works__ on __FreeBSD / GhostBSD__ and OpenBSD / FuguIta, deps same as Linux\n\n__\u2022\u200e \ud83d\udfe9 Windows - Works__ natively\n\n__\u2022\u200e \ud83d\udfe9 MacOS - Works__ on macOS HighSierra 10.13\n\n# \ud83d\udcd9 Additional deps\n__Unstead zypper you need to use system package manager: pkg, apt, dnf, pacman, etc__\n\n`- = - = -`\n### \ud83d\udc27 On Linux/BSD - \u25b6\ufe0f KDE (any display server)\n\n- Native support. No additional dependencies are needed.\n\nIt seems that all dependencies are listed below are already installed by default in all KDE distributions\n###### The only minimum requirement is dbus, klipper (which is now built-in into KDE), and an `dbus-python`\n\n### \ud83d\udc27 On Linux/BSD - X11\n- Install `xsel` or `xclip` package\n\nExample: _sudo zypper install xsel_ __OR__ _sudo zypper install xclip_\n\n`- = - = -`\n### \ud83d\udc27 On Linux/BSD - Wayland\n- Install `wl-clipboard` package\n\nExample: _sudo zypper install wl-clipboard_\n\n`- = - = -`\n### \ud83d\udc38 On Android\nClipboard works only in Termux.\nAnd you need install additional deps in it.\n* Install ```Termux:API``` from F-Droid\n* Run ```pkg install termux-api```\n* Check it - run ```termux-clipboard-get```\n\n# License\nThis code is under [Mozilla Public License Version 2.0](/../../blob/main/LICENSE).\n\n# Contribution / Issues\n\ud83d\udcd5 __[!!] If you encouter an error, please read the error text very closely.\nThe module is specially written so that errors give you a complete answer even if you a lamer__\n\n* \ud83e\udd7c __Pull requests are welcome!__\n* \ud83c\udf08 Feel free to write Issues! The developer can answer you in the following languages: Ukrainian, English, Russian.\n* Don't forget to attach version (`pip3 show clipman`) and error text with `clipman.init(debug=True)` :)\n* \u23e9 To speed up the process write to [maintainer](https://github.com/NikitaBeloglazov)\n",
    "bugtrack_url": null,
    "license": "MPL 2.0 License",
    "summary": "Python3 module for working with clipboard. Created because pyperclip is discontinued.",
    "version": "3.2.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/NikitaBeloglazov/clipman/issues",
        "Homepage": "https://github.com/NikitaBeloglazov/clipman"
    },
    "split_keywords": [
        "clipman",
        "clipboard",
        "copy",
        "paste",
        "xclip"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e166bac38812c9ed1ee1dd29a0a2ee7cb7d9b2654eff3117326f06777731c00",
                "md5": "b24ffb8828938a73ad515770212a43a5",
                "sha256": "dfebaf791501e06d13b28ec723d9803c9411b04c48b9c936345f36e79b1bcb1f"
            },
            "downloads": -1,
            "filename": "clipman-3.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b24ffb8828938a73ad515770212a43a5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 17417,
            "upload_time": "2024-02-23T02:51:59",
            "upload_time_iso_8601": "2024-02-23T02:51:59.714391Z",
            "url": "https://files.pythonhosted.org/packages/6e/16/6bac38812c9ed1ee1dd29a0a2ee7cb7d9b2654eff3117326f06777731c00/clipman-3.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7ec1be141d65cfd2a48c0be4db6408fb53ef383e3e27ee57bbde17f635dd8562",
                "md5": "ea7dc16c90d1c059e2729c2e85317e77",
                "sha256": "7d4464355f0feaec264fa0976cd979b251eed3f2c6d8db4fb8d30c6ff6b3aa02"
            },
            "downloads": -1,
            "filename": "clipman-3.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ea7dc16c90d1c059e2729c2e85317e77",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 18262,
            "upload_time": "2024-02-23T02:52:03",
            "upload_time_iso_8601": "2024-02-23T02:52:03.050046Z",
            "url": "https://files.pythonhosted.org/packages/7e/c1/be141d65cfd2a48c0be4db6408fb53ef383e3e27ee57bbde17f635dd8562/clipman-3.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-23 02:52:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NikitaBeloglazov",
    "github_project": "clipman",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "clipman"
}
        
Elapsed time: 0.22457s