# cups-printer
Retrieve all printers from a CUPS server. It's a simple command-line tool that
allows one to output the existing printers or write them to a file.
## Installation
It may require that the development package for CUPS is installed, e.g.
`$ sudo dnf -y install cups-devel`.
### PyPI
The package is hosted on [PyPI](https://pypi.org/project/cups_printers/).
It depends on `typer` and `pycups`.
```bash
$ pip install cups_printer
```
### Manual setup
```bash
$ python3 -m venv
$ source bin/activate
$ python3 setup.py
```
## Usage
The default CUPS instance which is used is `localhost`.
```bash
$ cups-printers --help
Usage: cups-printers [OPTIONS] COMMAND [ARGS]...
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --server TEXT The server URL of CUPS instance [env var: CUPS_SERVER] [default: localhost:631] │
│ --timeout TEXT Timeout for network operations [env var: TIMEOUT] [default: 5] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ output │
│ queue │
│ state │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
To get the details from a remote CUPS instance, use `--server`.
```bash
$ cups-printers --server 192.168.191.1:631 output json
```
## License
`cups-printers` ìs license under MIT.
Raw data
{
"_id": null,
"home_page": "https://github.com/audiusGmbH/cups-printers",
"name": "cups-printers",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "printers, cups",
"author": "Fabian Affolter",
"author_email": "fabian.affolter@audius.de",
"download_url": "https://files.pythonhosted.org/packages/87/ee/aa59db82ef80239450282a2e5b2e67d831fb128775d2deeace7868d077af/cups_printers-1.0.0.tar.gz",
"platform": null,
"description": "# cups-printer\n\nRetrieve all printers from a CUPS server. It's a simple command-line tool that\nallows one to output the existing printers or write them to a file.\n\n## Installation\n\nIt may require that the development package for CUPS is installed, e.g. \n`$ sudo dnf -y install cups-devel`.\n\n### PyPI\n\nThe package is hosted on [PyPI](https://pypi.org/project/cups_printers/).\nIt depends on `typer` and `pycups`.\n\n```bash\n$ pip install cups_printer\n```\n\n### Manual setup\n\n```bash\n$ python3 -m venv \n$ source bin/activate\n$ python3 setup.py\n```\n\n## Usage\n\nThe default CUPS instance which is used is `localhost`.\n\n```bash\n$ cups-printers --help\n\n \n Usage: cups-printers [OPTIONS] COMMAND [ARGS]... \n \n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --server TEXT The server URL of CUPS instance [env var: CUPS_SERVER] [default: localhost:631] \u2502\n\u2502 --timeout TEXT Timeout for network operations [env var: TIMEOUT] [default: 5] \u2502\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 output \u2502\n\u2502 queue \u2502\n\u2502 state \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\nTo get the details from a remote CUPS instance, use `--server`.\n\n```bash\n$ cups-printers --server 192.168.191.1:631 output json\n```\n\n## License\n\n`cups-printers` \u00ecs license under MIT.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool to get the printers from a running CUPS instance",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/audiusGmbH/cups-printers",
"Repository": "https://github.com/audiusGmbH/cups-printers"
},
"split_keywords": [
"printers",
" cups"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65c2320055391852bd5c4ecb592ead58425e4312d631653feb77460688528276",
"md5": "46f5edaa722cc780502e4830a991048c",
"sha256": "68510ec9b1e19840a0fa2bd477873046d0dca1b4ef90b75b672c012aacb09e96"
},
"downloads": -1,
"filename": "cups_printers-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46f5edaa722cc780502e4830a991048c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 7168,
"upload_time": "2024-03-20T20:40:01",
"upload_time_iso_8601": "2024-03-20T20:40:01.779480Z",
"url": "https://files.pythonhosted.org/packages/65/c2/320055391852bd5c4ecb592ead58425e4312d631653feb77460688528276/cups_printers-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87eeaa59db82ef80239450282a2e5b2e67d831fb128775d2deeace7868d077af",
"md5": "594b5a2c721011e97480ffdb2d236daf",
"sha256": "9a8fd0c83286ddb0d5b3a8ff932279b6588b0e4bd0f33dd170bfa9e36d8bebc1"
},
"downloads": -1,
"filename": "cups_printers-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "594b5a2c721011e97480ffdb2d236daf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 4414,
"upload_time": "2024-03-20T20:40:03",
"upload_time_iso_8601": "2024-03-20T20:40:03.702602Z",
"url": "https://files.pythonhosted.org/packages/87/ee/aa59db82ef80239450282a2e5b2e67d831fb128775d2deeace7868d077af/cups_printers-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 20:40:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "audiusGmbH",
"github_project": "cups-printers",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cups-printers"
}
JSON
